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.
| Improve this Doc View Source

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 Source

AllowArgumentSeparator

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

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

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

https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html

| Improve this Doc View Source

Description

A description of the command.

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

ExtendedHelpText

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

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

FullName

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

Declaration
public string FullName { get; set; }
Property Value
Type Description
System.String
See Also
| 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.

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

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>
| 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 &apos;@' as a response file.

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

ShowInHelpText

Determines if this command appears in generated help text.

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

UnrecognizedArgumentHandling

Set the behavior for how to handle unrecognized arguments.

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

UsePagerForHelpText

Whether a Pager should be used to display help text.

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