Click or drag to resize

ParameterAttribute Constructor (String, Boolean, Boolean, String)

Initializes a new instance of the ParameterAttribute

Namespace:  Cauldron.Consoles
Assembly:  Cauldron.Consoles (in Cauldron.Consoles.dll) Version: 3.2.0.1 (3.2.0.1)
Syntax
C#
Copy
public ParameterAttribute(
	string description,
	bool valueOptional,
	bool isRequired,
	params 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