AliasAttribute Class

Defines an alternative name for a command line argument or a subcommand.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.0.0
C#
public sealed class AliasAttribute : Attribute
Inheritance
Object    Attribute    AliasAttribute

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 the WriteUsage(UsageWriter) method includes the aliases. Set the IncludeAliasInDescription property to to exclude them.

  Note

If the Mode property is LongShort, and the argument this is applied to does not have a long name, this attribute is ignored.

This attribute can also be applied to classes that implement the ICommand interface to specify an alias for that command. In that case, inclusion of the aliases in the command list usage help is controlled by the IncludeCommandAliasInCommandList property.

Constructors

AliasAttribute Initializes a new instance of the AliasAttribute class.

Properties

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

Methods

EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also