GetString

GetString class

Used to get strings.

Inheritence: Rhino.Input.Custom.GetBaseClassGetString
Derived Classes:

Namespace: Rhino.Input.Custom
GetString: references

Constructors (2)

GetBaseClass()

Initializes a new instance of the GetBaseClass class

GetString()

Constructs a new GetString.

Methods (68)

AcceptColor(bool enable)

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.

AcceptCustomMessage(bool enable)

AcceptEnterWhenDone(bool enable)

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.

AcceptNothing(bool enable)

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.

AcceptNumber(bool enable, bool acceptZero)

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.

AcceptPoint(bool enable)

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.

AcceptString(bool enable)

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.

AcceptUndo(bool enable)

If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue, bool hiddenOption)

Adds a command line option.

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue)

Adds a command line option.

AddOption(LocalizeStringPair optionName)

Adds a command line option.

AddOption(string englishOption, string englishOptionValue, bool hiddenOption)

Adds a command line option.

AddOption(string englishOption, string englishOptionValue)

Adds a command line option.

AddOption(string englishOption)

Adds a command line option.

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue, string prompt)

Add a command line option to get colors and automatically save the value.

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue)

Add a command line option to get colors and automatically save the value.

AddOptionColor(string englishName, ref OptionColor colorValue, string prompt)

Add a command line option to get colors and automatically save the value.

AddOptionColor(string englishName, ref OptionColor colorValue)

Add a command line option to get colors and automatically save the value.

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue, string prompt)

Adds a command line option to get numbers and automatically saves the value.

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue)

Adds a command line option to get numbers and automatically save the value.

AddOptionDouble(string englishName, ref OptionDouble numberValue, string prompt)

Adds a command line option to get numbers and automatically save the value.

AddOptionDouble(string englishName, ref OptionDouble numberValue)

Adds a command line option to get numbers and automatically save the value.

AddOptionEnumList(string englishOptionName, T defaultValue, T[] include)

Adds a choice of enumerated values as list option. Allows to include only some enumerated values.

AddOptionEnumList(string englishOptionName, T defaultValue)

Adds a choice of enumerated values as list option

AddOptionEnumSelectionList(string englishOptionName, IEnumerable<T> enumSelection, int listCurrentIndex)

Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue, string prompt)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(string englishName, ref OptionInteger intValue, string prompt)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(string englishName, ref OptionInteger intValue)

Adds a command line option to get integers and automatically save the value.

AddOptionList(LocalizeStringPair optionName, IEnumerable<LocalizeStringPair> listValues, int listCurrentIndex)

Adds a command line list option.

AddOptionList(string englishOptionName, IEnumerable<string> listValues, int listCurrentIndex)

Adds a command line list option.

AddOptionToggle(LocalizeStringPair optionName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

AddOptionToggle(string englishName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

ClearCommandOptions()

Clear all command options.

ClearDefault()

Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.

Color()

Gets a color if Get*() returns GetResult.Color.

CommandResult()

Helper method for getting command result value from getter results.

CustomMessage()

Dispose()

Dispose(bool disposing)

EnableTransparentCommands(bool enable)

Control the availability of transparent commands during the get.

Get()

Returns the string that the user typed. By default, space stops the string input.

GetLiteralString()

Returns the string that the user typed. By default, space does not stop input.

GetSelectedEnumValue()

Returns the selected enumerated value. Use this in combination with <b>AddOptionEnumList{T}(string, T)</b> .
This must be called directly after having called a Get method, and having obtained a value.

GetSelectedEnumValueFromSelectionList(IEnumerable<T> selectionList)

Returns the selected enumerated value by looking at the list of values from which to select. Use this in combination with <b>AddOptionEnumSelectionList{T}</b>

GotDefault()

Returns True if user pressed Enter to accept a default point, number, or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.

Line2d()

Returns two points defining the location in the view window of the 2d line selected in GetPoint::Get2dLine().
(0,0) = upper left corner of window.

Number()

Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.

Option()

OptionIndex()

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;

Point()

Gets a point if Get*() returns GetResult.Point.

Point2d()

Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint(). (0,0) = upper left corner of window.

PostCustomMessage(object messageData)

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.

Result()

Returns result of the Get*() call.

SetCommandPrompt(string prompt)

Sets prompt message that appears in the command prompt window.

SetCommandPromptDefault(string defaultValue)

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.

SetDefaultColor(Color defaultColor)

Sets a color as default value that will be returned if the user presses ENTER key during the get.

SetDefaultInteger(int defaultValue)

Sets a number as default value that will be returned if the user presses ENTER key during the get.

SetDefaultNumber(double defaultNumber)

Sets a number as default value that will be returned if the user presses ENTER key during the get.

SetDefaultPoint(Point3d point)

Sets a point as default value that will be returned if the user presses the ENTER key during the get.

SetDefaultString(string defaultValue)

Sets a string as default value that will be returned if the user presses ENTER key during the get.

SetOptionVaries(int optionIndex, bool varies)

Sets a command line option value to print "Varies" instead of the regular value.

SetWaitDuration(int milliseconds)

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.

StringResult()

Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.

Vector()

Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).

View()

Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.

Nothing found