| ParameterAttribute Constructor (String, Boolean, Boolean, String) |
Namespace:
Cauldron.Consoles
Assembly:
Cauldron.Consoles (in Cauldron.Consoles.dll) Version: 3.2.0.2
Syntax public ParameterAttribute(
string description,
bool valueOptional,
bool isRequired,
params string[] parameters
)
public:
ParameterAttribute(
String^ description,
bool valueOptional,
bool isRequired,
... array<String^>^ parameters
)
Parameters
- description
- Type: SystemString
A short description of the parameter. A description paragraph can be highlightened by adding !! at the beginning of the line.
The following keyword can also be used:
- $ux$ - Replaced by \n!!USAGE EXAMPLE: executableName -parameter
- $mm$ - Replaced by \n!!executableName -parameter
- $me$ - Replaced by executableName
- $pm$ - Replaced by parameter
If an implementation of ILocalizationSource exist, the parser will use description as a key for Locale - valueOptional
- Type: SystemBoolean
Indicates that the parameter's value is mandatory. Default is false. - isRequired
- Type: SystemBoolean
Indicates if the parameter is mandatory - parameters
- Type: SystemString
A list of parameters and aliases
See Also