AliasAttribute Class |
Inheritance HierarchyNamespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.4.0
SyntaxThe AliasAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AliasAttribute |
Initializes a new instance of the AliasAttribute class.
|
Properties| Name | Description | |
|---|---|---|
 | Alias |
Gets the alternative name for the command line argument.
|
| TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
| Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks Note |
|---|
| To specify multiple aliases, apply this attribute multiple times. |
The aliases for a command line argument can be used instead of their regular name to specify the parameter on the command line. For example, this can be used to have a shorter name for an argument (e.g. "-v" as an alternative to "-Verbose").
All regular command line argument names and aliases used by an instance of the CommandLineParser class must be unique.
By default, the command line usage help generated by WriteUsage(TextWriter, Int32, WriteUsageOptions) does not list the aliases. Either manually add them to the description, or set the IncludeAliasInDescription property to .
See Also