Class HelpOptionAttribute

Namespace

McMaster.Extensions.CommandLineUtils

Assembly

McMaster.Extensions.CommandLineUtils.dll

The option used to determine if help text should be displayed. This should only be used once per command line app.

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Property)]
public sealed class HelpOptionAttribute : OptionAttributeBase

Inheritance

object

Attribute

OptionAttributeBase

HelpOptionAttribute

Inherited Members

OptionAttributeBase.ShortName

OptionAttributeBase.LongName

OptionAttributeBase.SymbolName

OptionAttributeBase.ValueName

OptionAttributeBase.Description

OptionAttributeBase.ShowInHelpText

OptionAttributeBase.Inherited

Constructors

HelpOptionAttribute()

Initializes a new HelpOptionAttribute with the template -?|-h|--help.

public HelpOptionAttribute()

HelpOptionAttribute(string)

Initializes a new HelpOptionAttribute.

public HelpOptionAttribute(string template)

Parameters

template string

The string template. This is parsed into ShortName and LongName.

Properties

Template

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

public string Template { get; set; }

Property Value

string