CommandLine.Core.Verb Class Reference

Public Member Functions
	Verb (string name, string helpText, bool hidden, bool isDefault, string[] aliases)

Static Public Member Functions
static Verb	FromAttribute (VerbAttribute attribute)
static IEnumerable< Tuple< Verb, Type > >	SelectFromTypes (IEnumerable< Type > types)

Properties
string	Name [get, private set]
string	HelpText [get, private set]
bool	Hidden [get, private set]
bool	IsDefault [get, private set]
string[]	Aliases [get, private set]

Detailed Description

Definition at line 10 of file Verb.cs.

Constructor & Destructor Documentation

Verb()

CommandLine.Core.Verb.Verb	(	string	name,
		string	helpText,
		bool	hidden,
		bool	isDefault,
		string[]	aliases
	)

Definition at line 12 of file Verb.cs.

        {
            if (string.IsNullOrWhiteSpace(name))
            {
                throw new ArgumentNullException(nameof(name));
            }
 
            Name = name;
 
            HelpText = helpText ?? throw new ArgumentNullException(nameof(helpText));
            Hidden = hidden;
            IsDefault = isDefault;
            Aliases = aliases ?? new string[0];
        }

Member Function Documentation

FromAttribute()

static Verb CommandLine.Core.Verb.FromAttribute ( VerbAttribute  attribute )

static

Definition at line 37 of file Verb.cs.

        {
            return new Verb(attribute.Name,
                            attribute.HelpText,
                            attribute.Hidden,
                            attribute.IsDefault,
                            attribute.Aliases
                           );
        }

SelectFromTypes()

static IEnumerable< Tuple< Verb, Type > > CommandLine.Core.Verb.SelectFromTypes ( IEnumerable< Type >  types )

static

Definition at line 47 of file Verb.cs.

        {
            return from type in types
                   let attrs = type.GetTypeInfo()
                                   .GetCustomAttributes(typeof(VerbAttribute), true)
                                   .ToArray()
                   where attrs.Length == 1
                   select Tuple.Create(FromAttribute((VerbAttribute)attrs.Single()),
                                       type
                                      );
        }

Property Documentation

Aliases

string [] CommandLine.Core.Verb.Aliases

getprivate set

Definition at line 35 of file Verb.cs.

{ get; private set; }

HelpText

string CommandLine.Core.Verb.HelpText

getprivate set

Definition at line 29 of file Verb.cs.

{ get; private set; }

Hidden

bool CommandLine.Core.Verb.Hidden

getprivate set

Definition at line 31 of file Verb.cs.

{ get; private set; }

IsDefault

bool CommandLine.Core.Verb.IsDefault

getprivate set

Definition at line 33 of file Verb.cs.

{ get; private set; }

Name

string CommandLine.Core.Verb.Name

getprivate set

Definition at line 27 of file Verb.cs.

{ get; private set; }

---

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

• deps/commandlineparser/src/CommandLine/Core/Verb.cs