GetString Methods |
The GetString type exposes the following members.
Name | Description | |
---|---|---|
AcceptColor |
If you want to allow the user to be able to type in a color r,g,b or name
during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptColor(true)
before calling GetPoint()/GetObject(). If the user chooses to type in a color,
then the result code GetResult.Color is returned and you can use RhinoGet.Color()
to get the value of the color. If the get accepts points, then the user will not
be able to type in r,g,b colors but will be able to type color names.
(Inherited from GetBaseClass.) | |
AcceptCustomMessage | (Inherited from GetBaseClass.) | |
AcceptEnterWhenDone |
There are instances of RhinoGet that prompt with "Press Enter when Done." yet do not call AcceptNothing().
On the Mac, these instances need an additional call to AcceptEnterWhenDone() so the GetPointOptions dialog
can correctly enable the Done button.
(Inherited from GetBaseClass.) | |
AcceptNothing |
If you want to allow the user to be able to press enter in order to
skip selecting a something in GetPoint.Get(), GetObject::GetObjects(),
etc., then call AcceptNothing( true ) beforehand.
(Inherited from GetBaseClass.) | |
AcceptNumber |
If you want to allow the user to be able to type in a number during GetPoint.Get(),
GetObject::GetObjects(), etc., then call AcceptNumber() beforehand.
If the user chooses to type in a number, then the result code GetResult.Number is
returned and you can use RhinoGet.Number() to get the value of the number. If you
are using GetPoint and you want "0" to return (0,0,0) instead of the number zero,
then set acceptZero = false.
(Inherited from GetBaseClass.) | |
AcceptPoint |
If you want to allow the user to be able to type in a point then call AcceptPoint(true)
before calling GetPoint()/GetObject(). If the user chooses to type in a number, then
the result code GetResult.Point is returned and you can use RhinoGet.Point()
to get the value of the point.
(Inherited from GetBaseClass.) | |
AcceptString |
If you want to allow the user to be able to type in a string during GetPoint.Get(),
GetObject::GetObjects(), etc., then call AcceptString(true) before calling
GetPoint()/GetObject(). If the user chooses to type in a string, then the result code
GetResult.String is returned and you can use RhinoGet.String() to get the value of the string.
(Inherited from GetBaseClass.) | |
AcceptUndo |
If you want to allow the user to have an 'undo' option in GetPoint.Get(),
GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.
(Inherited from GetBaseClass.) | |
AddOption(LocalizeStringPair) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOption(String) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOption(LocalizeStringPair, LocalizeStringPair) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOption(String, String) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOption(LocalizeStringPair, LocalizeStringPair, Boolean) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOption(String, String, Boolean) |
Adds a command line option.
(Inherited from GetBaseClass.) | |
AddOptionColor(LocalizeStringPair, OptionColor) |
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionColor(String, OptionColor) |
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionColor(LocalizeStringPair, OptionColor, String) |
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionColor(String, OptionColor, String) |
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionDouble(LocalizeStringPair, OptionDouble) |
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionDouble(String, OptionDouble) |
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionDouble(LocalizeStringPair, OptionDouble, String) |
Adds a command line option to get numbers and automatically saves the value.
(Inherited from GetBaseClass.) | |
AddOptionDouble(String, OptionDouble, String) |
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionEnumListT(String, T) |
Adds a choice of enumerated values as list option
(Inherited from GetBaseClass.) | |
AddOptionEnumListT(String, T, T) |
Adds a choice of enumerated values as list option. Allows to include only some enumerated values.
(Inherited from GetBaseClass.) | |
AddOptionEnumSelectionListT |
Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
(Inherited from GetBaseClass.) | |
AddOptionInteger(LocalizeStringPair, OptionInteger) |
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionInteger(String, OptionInteger) |
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionInteger(LocalizeStringPair, OptionInteger, String) |
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionInteger(String, OptionInteger, String) |
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.) | |
AddOptionList(LocalizeStringPair, IEnumerableLocalizeStringPair, Int32) |
Adds a command line list option.
(Inherited from GetBaseClass.) | |
AddOptionList(String, IEnumerableString, Int32) |
Adds a command line list option.
(Inherited from GetBaseClass.) | |
AddOptionToggle(LocalizeStringPair, OptionToggle) |
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.) | |
AddOptionToggle(String, OptionToggle) |
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.) | |
ClearCommandOptions | Clear all command options. (Inherited from GetBaseClass.) | |
ClearDefault |
Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
(Inherited from GetBaseClass.) | |
Color | Gets a color if Get*() returns GetResult.Color. (Inherited from GetBaseClass.) | |
CommandResult |
Helper method for getting command result value from getter results.
(Inherited from GetBaseClass.) | |
CustomMessage | (Inherited from GetBaseClass.) | |
Dispose | (Inherited from GetBaseClass.) | |
Dispose(Boolean) | (Inherited from GetBaseClass.) | |
EnableTransparentCommands |
Control the availability of transparent commands during the get.
(Inherited from GetBaseClass.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | (Inherited from GetBaseClass.) | |
Get | Returns the string that the user typed. By default, space stops the string input. | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetLiteralString | Returns the string that the user typed. By default, space does not stop input. | |
GetSelectedEnumValueT |
Returns the selected enumerated value. Use this in combination with AddOptionEnumListT(String, T).
(Inherited from GetBaseClass.)This must be called directly after having called a Get method, and having obtained a Option value. | |
GetSelectedEnumValueFromSelectionListT |
Returns the selected enumerated value by looking at the list of values from which to select.
Use this in combination with AddOptionEnumSelectionListT(String, IEnumerableT, Int32) (Inherited from GetBaseClass.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GotDefault |
Returns true if user pressed Enter to accept a default point, number,
or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.
(Inherited from GetBaseClass.) | |
Line2d |
Returns two points defining the location in the view window of the 2d line selected
in GetPoint::Get2dLine().
(Inherited from GetBaseClass.)(0,0) = upper left corner of window. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Number |
Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
(Inherited from GetBaseClass.) | |
Option | (Inherited from GetBaseClass.) | |
OptionIndex | (Inherited from GetBaseClass.) | |
PickRectangle |
If the get was a GetObjects() and the mouse was used to select the objects,
then the returned rectangle has left < right and top < bottom. This rectangle
is the Windows GDI screen coordinates of the picking rectangle.
RhinoViewport.GetPickXform( pick_rect, pick_xform )
will calculate the picking transformation that was used.
In all other cases, left=right=top=bottom=0;
(Inherited from GetBaseClass.) | |
Point |
Gets a point if Get*() returns GetResult.Point.
(Inherited from GetBaseClass.) | |
Point2d |
Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint().
(0,0) = upper left corner of window.
(Inherited from GetBaseClass.) | |
Rectangle2d |
Returns the location in the view of the 2d rectangle selected in GetPoint::Get2dRectangle().
rect.left < rect.right and rect.top < rect.bottom
(0,0) = upper left corner of window.
(Inherited from GetBaseClass.) | |
Result | Returns result of the Get*() call. (Inherited from GetBaseClass.) | |
SetCommandPrompt |
Sets prompt message that appears in the command prompt window.
(Inherited from GetBaseClass.) | |
SetCommandPromptDefault |
Sets message that describes what default value will be used if the user presses enter.
This description appears in angle brackets <> in the command prompt window. You do
not need to provide a default value description unless you explicitly enable AcceptNothing.
(Inherited from GetBaseClass.) | |
SetDefaultColor |
Sets a color as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.) | |
SetDefaultInteger |
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.) | |
SetDefaultNumber |
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.) | |
SetDefaultPoint |
Sets a point as default value that will be returned if the user presses the ENTER key during the get.
(Inherited from GetBaseClass.) | |
SetDefaultString |
Sets a string as default value that will be returned
if the user presses ENTER key during the get.
(Inherited from GetBaseClass.) | |
SetOptionVaries |
Sets a command line option value to print "Varies" instead of the regular value.
(Inherited from GetBaseClass.) | |
SetWaitDuration |
Sets the wait duration (in milliseconds) of the getter. If the duration passes without
the user making a decision, the GetResult.Timeout code is returned.
(Inherited from GetBaseClass.) | |
StringResult |
Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
(Inherited from GetBaseClass.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Vector |
Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).
(Inherited from GetBaseClass.) | |
View |
Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.
(Inherited from GetBaseClass.) |