ShortAliasAttribute Class

Defines an alternative short name for a command line argument.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.0.0

C#

public sealed class ShortAliasAttribute : Attribute

VB

Public NotInheritable Class ShortAliasAttribute
	Inherits Attribute

Dim instance As ShortAliasAttribute

C++

public ref class ShortAliasAttribute sealed : public Attribute

Inheritance: Object Attribute ShortAliasAttribute

Remarks

Note

To specify multiple aliases, apply this attribute multiple times.

Note

This attribute specifies short name aliases used with LongShort mode. It is ignored if the Mode property is not LongShort, or if the argument doesn't have a primary ShortName.

The short aliases for a command line argument can be used instead of the regular short name to specify the parameter on the command line.

All short argument names and short aliases defined by a single arguments type must be unique.

By default, the command line usage help generated by WriteUsage(UsageWriter) includes the aliases. Set the IncludeAliasInDescription property to to exclude them.

Constructors

ShortAliasAttribute

Initializes a new instance of the AliasAttribute class.

Properties

Alias	Gets the alternative short name for the command line argument.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

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)