Class CommandAttribute
Represents a command line application using attributes to define options and arguments.
Inheritance
Inherited Members
Namespace: McMaster.Extensions.CommandLineUtils
Assembly: McMaster.Extensions.CommandLineUtils.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public sealed class CommandAttribute : Attribute
Constructors
| Improve this Doc View SourceCommandAttribute()
Initializes a new CommandAttribute.
Declaration
public CommandAttribute()
CommandAttribute(String)
Initializes a new CommandAttribute.
Declaration
public CommandAttribute(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the command. |
CommandAttribute(String[])
Initializes a new CommandAttribute.
Declaration
public CommandAttribute(params string[] names)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | names | The names of the command. The first name given is the primary name |
Properties
| Improve this Doc View SourceAllowArgumentSeparator
Allow '--' to be used to stop parsing arguments. AllowArgumentSeparator
Declaration
public bool AllowArgumentSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ClusterOptions
One or more options of NoValue, followed by at most one option that takes values, should be accepted when grouped behind one '-' delimiter.
When true, the following are equivalent.
-abcXyellow
-abcX=yellow
-abcX:yellow
-abc -X=yellow
-ab -cX=yellow
-a -b -c -Xyellow
-a -b -c -X yellow
-a -b -c -X=yellow
-a -b -c -X:yellow
This defaults to true unless an option with a short name of two or more characters is added.
Declaration
public bool ClusterOptions { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
| Improve this Doc View SourceDescription
A description of the command. Description
Declaration
public string? Description { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.String> |
ExtendedHelpText
Additional text that appears at the bottom of generated help text. ExtendedHelpText
Declaration
public string? ExtendedHelpText { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.String> |
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.Nullable<System.String> |
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.Nullable<System.String> |
Names
THe names of the command. The first is the primary name. All other names are aliases.
Declaration
public IEnumerable<string> Names { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
OptionsComparison
The way arguments and options are matched.
Declaration
public StringComparison OptionsComparison { get; set; }
Property Value
Type | Description |
---|---|
System.StringComparison |
ParseCulture
Specifies the culture used to convert values into types.
Declaration
public CultureInfo ParseCulture { get; set; }
Property Value
Type | Description |
---|---|
System.Globalization.CultureInfo |
ResponseFileHandling
Treat arguments beginning as '@' as a response file. ResponseFileHandling
Declaration
public ResponseFileHandling ResponseFileHandling { get; set; }
Property Value
Type | Description |
---|---|
ResponseFileHandling |
ShowInHelpText
Determines if this command appears in generated help text. ShowInHelpText
Declaration
public bool ShowInHelpText { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ThrowOnUnexpectedArgument
Throw when unexpected arguments are encountered. ThrowOnUnexpectedArgument
Declaration
public bool ThrowOnUnexpectedArgument { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |