Class CommandAttribute

Represents a command line application using attributes to define options and arguments.

Inheritance
System.Object
System.Attribute
CommandAttribute
Namespace: McMaster.Extensions.CommandLineUtils
Assembly: McMaster.Extensions.CommandLineUtils.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public sealed class CommandAttribute : Attribute

Constructors

| Improve this Doc View Source

CommandAttribute()

Initializes a new CommandAttribute.

Declaration
public CommandAttribute()
| Improve this Doc View Source

CommandAttribute(String)

Initializes a new CommandAttribute.

Declaration
public CommandAttribute(string name)
Parameters
Type Name Description
System.String name

The name of the command.

Properties

| Improve this Doc View Source

AllowArgumentSeparator

Allow '--' to be used to stop parsing arguments. AllowArgumentSeparator

Declaration
public bool AllowArgumentSeparator { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Description

A description of the command. Description

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ExtendedHelpText

Additional text that appears at the bottom of generated help text. ExtendedHelpText

Declaration
public string ExtendedHelpText { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

FullName

The full name of the command line application to show in help text. FullName

Declaration
public string FullName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Name

The name of the command line application. When this is a subcommand, it is the name of the word used to invoke the subcommand. Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

OptionsComparison

The way arguments and options are matched.

Declaration
public StringComparison OptionsComparison { get; set; }
Property Value
Type Description
System.StringComparison
| Improve this Doc View Source

ParseCulture

Specifies the culture used to convert values into types.

Declaration
public CultureInfo ParseCulture { get; set; }
Property Value
Type Description
System.Globalization.CultureInfo
| Improve this Doc View Source

ResponseFileHandling

Treat arguments beginning as '@' as a response file. ResponseFileHandling

Declaration
public ResponseFileHandling ResponseFileHandling { get; set; }
Property Value
Type Description
ResponseFileHandling
| Improve this Doc View Source

ShowInHelpText

Determines if this command appears in generated help text. ShowInHelpText

Declaration
public bool ShowInHelpText { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ThrowOnUnexpectedArgument

Throw when unexpected arguments are encountered. ThrowOnUnexpectedArgument

Declaration
public bool ThrowOnUnexpectedArgument { get; set; }
Property Value
Type Description
System.Boolean