GetBaseClass.AddOption Method (LocalizeStringPair, LocalizeStringPair, Boolean)

GetBaseClassAddOption Method (LocalizeStringPair, LocalizeStringPair, Boolean)

Adds a command line option.

Namespace:  Rhino.Input.Custom
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public int AddOption(
	LocalizeStringPair optionName,
	LocalizeStringPair optionValue,
	bool hiddenOption
)
Public Function AddOption ( 
	optionName As LocalizeStringPair,
	optionValue As LocalizeStringPair,
	hiddenOption As Boolean
) As Integer

Parameters

optionName
Type: Rhino.UILocalizeStringPair
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
optionValue
Type: Rhino.UILocalizeStringPair
The localized value visualized after an equality sign.
hiddenOption
Type: SystemBoolean
If true, the option is not displayed on the command line and the full option name must be typed in order to activate the option.

Return Value

Type: Int32
option index value (>0) or 0 if option cannot be added.
Version Information

Rhino for Windows

Supported in: 6.14
See Also

M:Rhino.Input.Custom.GetBaseClass.AddOption(Rhino.UI.LocalizeStringPair,Rhino.UI.LocalizeStringPair,System.Boolean)