Class ArgumentAttribute

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

Inheritance

System.Object

System.Attribute

ArgumentAttribute

Inherited Members

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

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, Nullable<String>)

Initializes a new ArgumentAttribute.

Declaration

public ArgumentAttribute(int order, string? name)

Parameters

Type	Name	Description
System.Int32	order	The order
System.Nullable<System.String>	name	The name

| Improve this Doc View Source

ArgumentAttribute(Int32, Nullable<String>, Nullable<String>)

Initializes a new ArgumentAttribute.

Declaration

public ArgumentAttribute(int order, string? name, string? description)

Parameters

Type	Name	Description
System.Int32	order	The order
System.Nullable<System.String>	name	The name
System.Nullable<System.String>	description	The description

Properties

| Improve this Doc View Source

Description

A description of the argument. Description.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

Name

The name of the argument. Name.

Declaration

public string? Name { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| 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. ShowInHelpText.

Declaration

public bool ShowInHelpText { get; set; }

Property Value

Type	Description
System.Boolean