Class OptionAttributeBase

Common option properties.

Inheritance

System.Object

System.Attribute

OptionAttributeBase

HelpOptionAttribute

OptionAttribute

VersionOptionAttribute

VersionOptionFromMemberAttribute

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

public abstract class OptionAttributeBase : Attribute

Properties

| Improve this Doc View Source

Description

A description of this option to show in generated help text. Description.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

Inherited

Determines if subcommands added to Commands should also have access to this option. Inherited.

Declaration

public bool Inherited { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LongName

The long command line flag used to identify this option. On command line, this is preceeded by a double dash: '--{LongName}'.

Declaration

public string? LongName { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

ShortName

The short command line flag used to identify this option. On command line, this is preceeded by a single '-{ShortName}'.

Declaration

public string? ShortName { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

ShowInHelpText

Determines if this option should be shown in generated help text. ShowInHelpText.

Declaration

public bool ShowInHelpText { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SymbolName

Can be used in addition to ShortName to add a single, non-English character. Example "-?".

Declaration

public string? SymbolName { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

Template

The option template. This is parsed into the short and long name.

Declaration

public string? Template { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

ValueName

The name of value(s) shown in help text when OptionType is not NoValue.

Declaration

public string? ValueName { get; set; }

Property Value

Type	Description
System.Nullable<System.String>