Search Results for

    Show / Hide Table of Contents

    Class HelpOptionAttribute

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

    Inheritance
    System.Object
    System.Attribute
    OptionAttributeBase
    HelpOptionAttribute
    Inherited Members
    OptionAttributeBase.ShortName
    OptionAttributeBase.LongName
    OptionAttributeBase.SymbolName
    OptionAttributeBase.ValueName
    OptionAttributeBase.Description
    OptionAttributeBase.ShowInHelpText
    OptionAttributeBase.Inherited
    Namespace: McMaster.Extensions.CommandLineUtils
    Assembly: McMaster.Extensions.CommandLineUtils.dll
    Syntax
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
    public sealed class HelpOptionAttribute : OptionAttributeBase

    Constructors

    | Improve this Doc View Source

    HelpOptionAttribute()

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

    Declaration
    public HelpOptionAttribute()
    | Improve this Doc View Source

    HelpOptionAttribute(String)

    Initializes a new HelpOptionAttribute.

    Declaration
    public HelpOptionAttribute(string template)
    Parameters
    Type Name Description
    System.String template

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

    Properties

    | 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.String
    • Improve this Doc
    • View Source
    In This Article
    Back to top