CommandLine.VerbAttribute Class Reference

Models a verb command specification. More...

Inheritance diagram for CommandLine.VerbAttribute:

Public Member Functions
	VerbAttribute (string name, bool isDefault=false, string[] aliases=null)
	Initializes a new instance of the CommandLine.VerbAttribute class.

Properties
string	Name [get, private set]
	Gets the verb name.
bool	Hidden [get, set]
	Gets or sets a value indicating whether a command line verb is visible in the help text.
string	HelpText [get, set]
	Gets or sets a short description of this command line option. Usually a sentence summary.
Type	ResourceType [get, set]
	Gets or sets the System.Type that contains the resources for HelpText.
bool	IsDefault [get, private set]
	Gets whether this verb is the default verb.
string[]	Aliases [get, private set]
	Gets or sets the aliases.

Private Attributes
readonly LocalizableAttributeProperty	helpText
Type	resourceType

Detailed Description

Models a verb command specification.

Definition at line 14 of file VerbAttribute.cs.

Constructor & Destructor Documentation

VerbAttribute()

CommandLine.VerbAttribute.VerbAttribute	(	string	name,
		bool	isDefault = false,
		string[]	aliases = null
	)

Initializes a new instance of the CommandLine.VerbAttribute class.

Parameters

name	The long name of the verb command.
isDefault	Whether the verb is the default verb.
aliases	aliases for this verb. i.e. "move" and "mv"

Exceptions

System.ArgumentException

Thrown if name is null, empty or whitespace and isDefault is false.

Definition at line 29 of file VerbAttribute.cs.

        {
            if (string.IsNullOrWhiteSpace(name))
            {
                throw new ArgumentException("name");
            }
 
            Name = name;
            IsDefault = isDefault;
            helpText = new LocalizableAttributeProperty(nameof(HelpText));
            resourceType = null;
            Aliases = aliases ?? new string[0];
        }

Member Data Documentation

helpText

readonly LocalizableAttributeProperty CommandLine.VerbAttribute.helpText

private

Definition at line 16 of file VerbAttribute.cs.

resourceType

Type CommandLine.VerbAttribute.resourceType

private

Definition at line 17 of file VerbAttribute.cs.

Property Documentation

Aliases

string [] CommandLine.VerbAttribute.Aliases

getprivate set

Gets or sets the aliases.

Definition at line 79 of file VerbAttribute.cs.

{ get; private set; }

HelpText

string CommandLine.VerbAttribute.HelpText

getset

Gets or sets a short description of this command line option. Usually a sentence summary.

Definition at line 56 of file VerbAttribute.cs.

        {
            get => helpText.Value ?? string.Empty;
            set => helpText.Value = value ?? throw new ArgumentNullException("value");
        }

Hidden

bool CommandLine.VerbAttribute.Hidden

getset

Gets or sets a value indicating whether a command line verb is visible in the help text.

Definition at line 51 of file VerbAttribute.cs.

{ get; set; }

IsDefault

bool CommandLine.VerbAttribute.IsDefault

getprivate set

Gets whether this verb is the default verb.

Definition at line 74 of file VerbAttribute.cs.

{ get; private set; }

Name

string CommandLine.VerbAttribute.Name

getprivate set

Gets the verb name.

Definition at line 46 of file VerbAttribute.cs.

{ get; private set; }

ResourceType

Type CommandLine.VerbAttribute.ResourceType

getset

Gets or sets the System.Type that contains the resources for HelpText.

Definition at line 65 of file VerbAttribute.cs.

        {
            get => resourceType;
            set => resourceType = helpText.ResourceType = value;
        }

---

The documentation for this class was generated from the following file:

• deps/commandlineparser/src/CommandLine/VerbAttribute.cs