CommandLineOption

References
public sealed class CommandLineOption

Properties

CurrentListOptionIndex

#ExampleSince v5.0
public int CurrentListOptionIndex { get; }

CurrentNumericValue

#Since v8.0
public double CurrentNumericValue { get; }

CurrentToggleValue

#Since v8.0
public bool? CurrentToggleValue { get; }

EnglishName

#Since v5.0
public string EnglishName { get; }
The English command option name

Index

#Since v5.0
public int Index { get; }

LocalName

#Since v6.24
public string LocalName { get; }
The localized command option name

OptionType

#Since v8.0
public CommandLineOptionType OptionType { get; }
The type of this command line option

StringOptionValue

#Since v6.24
public string StringOptionValue { get; }
Assigned by RhinoGet.Get if an option value is specified in a script or by a command window control.

Methods

IsValidOptionName

#Since v5.0
public static bool IsValidOptionName(string optionName)
Test a string to see if it can be used as an option name in any of the RhinoGet::AddCommandOption...() functions.
Parameters:
optionName (string)The string to be tested.
Returns: true if string can be used as an option name.

IsValidOptionValueName

#Since v5.0
public static bool IsValidOptionValueName(string optionValue)
Test a string to see if it can be used as an option value in RhinoGet::AddCommandOption, RhinoGet::AddCommandOptionToggle, or RhinoGet::AddCommandOptionList.
Parameters:
optionValue (string)The string to be tested.
Returns: true if string can be used as an option value.

ListOptions

#Since v8.0
public string[] ListOptions(bool english)
If this OptionType is a list, then the option should contain a list of values that the user can pick from.
Parameters:
english (bool)return the English or local versions of the list options

ToggleValues

#Since v8.0
public void ToggleValues(bool english, out string offValue, out string onValue)
Parameters:
english (bool)
offValue (out string)
onValue (out string)