Class ArgumentAttribute

Represents one or many positional command line arguments. Arguments are parsed based the Order given.

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

Constructors

| Improve this Doc View Source

ArgumentAttribute(Int32)

Initializes a new ArgumentAttribute.

Declaration
public ArgumentAttribute(int order)
Parameters
Type Name Description
System.Int32 order

The order
| Improve this Doc View Source

ArgumentAttribute(Int32, String)

Initializes a new ArgumentAttribute.

Declaration
public ArgumentAttribute(int order, string name)
Parameters
Type Name Description
System.Int32 order

The order
System.String name

The name
| Improve this Doc View Source

ArgumentAttribute(Int32, String, String)

Initializes a new ArgumentAttribute.

Declaration
public ArgumentAttribute(int order, string name, string description)
Parameters
Type Name Description
System.Int32 order

The order
System.String name

The name
System.String description

The description

Properties

| Improve this Doc View Source

Description

A description of the argument.

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

Name

The name of the argument.

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

Order

The order in which the argument is expected, relative to other arguments.

Declaration
public int Order { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ShowInHelpText

Determines if the argument appears in the generated help-text.

Declaration
public bool ShowInHelpText { get; set; }
Property Value
Type Description
System.Boolean
See Also

See Also