Search Results for

    Show / Hide Table of Contents

    Class CommandLineApplication<TModel>

    Describes a set of command line arguments, options, and execution behavior using a type of TModel to model the application.

    Inheritance
    System.Object
    CommandLineApplication
    CommandLineApplication<TModel>
    Implements
    System.IServiceProvider
    System.IDisposable
    IModelAccessor
    Inherited Members
    CommandLineApplication.Parent
    CommandLineApplication.HelpTextGenerator
    CommandLineApplication.Name
    CommandLineApplication.FullName
    CommandLineApplication.Description
    CommandLineApplication.ShowInHelpText
    CommandLineApplication.ExtendedHelpText
    CommandLineApplication.Options
    CommandLineApplication.UsePagerForHelpText
    CommandLineApplication.Names
    CommandLineApplication.OptionHelp
    CommandLineApplication.OptionVersion
    CommandLineApplication.Arguments
    CommandLineApplication.RemainingArguments
    CommandLineApplication.UnrecognizedArgumentHandling
    CommandLineApplication.IsShowingInformation
    CommandLineApplication.LongVersionGetter
    CommandLineApplication.ShortVersionGetter
    CommandLineApplication.Commands
    CommandLineApplication.AllowArgumentSeparator
    CommandLineApplication.ResponseFileHandling
    CommandLineApplication.OptionsComparison
    CommandLineApplication.ClusterOptions
    CommandLineApplication.OptionNameValueSeparators
    CommandLineApplication.ValueParsers
    CommandLineApplication.WorkingDirectory
    CommandLineApplication.Out
    CommandLineApplication.Error
    CommandLineApplication.GetOptions()
    CommandLineApplication.AddName(String)
    CommandLineApplication.AddSubcommand(CommandLineApplication)
    CommandLineApplication.Command(String, Action<CommandLineApplication>)
    CommandLineApplication.Command<TModel>(String, Action<CommandLineApplication<TModel>>)
    CommandLineApplication.Option(String, String, CommandOptionType)
    CommandLineApplication.Option(String, String, CommandOptionType, Boolean)
    CommandLineApplication.Option(String, String, CommandOptionType, Action<CommandOption>)
    CommandLineApplication.Option(String, String, CommandOptionType, Action<CommandOption>, Boolean)
    CommandLineApplication.Option<T>(String, String, CommandOptionType, Action<CommandOption>, Boolean)
    CommandLineApplication.Argument(String, String, Boolean)
    CommandLineApplication.Argument(String, String, Action<CommandArgument>, Boolean)
    CommandLineApplication.Argument<T>(String, String, Action<CommandArgument>, Boolean)
    CommandLineApplication.OnExecute(Func<Int32>)
    CommandLineApplication.OnExecuteAsync(Func<CancellationToken, Task<Int32>>)
    CommandLineApplication.OnParsingComplete(Action<ParseResult>)
    CommandLineApplication.Parse(String[])
    CommandLineApplication.MakeSuggestionsInErrorMessage
    CommandLineApplication.HandleParseResult(ParseResult)
    CommandLineApplication.Execute(String[])
    CommandLineApplication.ExecuteAsync(String[], CancellationToken)
    CommandLineApplication.HelpOption(String)
    CommandLineApplication.HelpOption(String, Boolean)
    CommandLineApplication.VersionOption(String, String, String)
    CommandLineApplication.VersionOption(String, Func<String>, Func<String>)
    CommandLineApplication.ShowHint()
    CommandLineApplication.ShowHelp()
    CommandLineApplication.ShowHelp(Boolean)
    CommandLineApplication.GetHelpText()
    CommandLineApplication.ShowVersion()
    CommandLineApplication.GetVersionText()
    CommandLineApplication.GetFullNameAndVersion()
    CommandLineApplication.ShowRootCommandFullNameAndVersion()
    CommandLineApplication.Conventions
    CommandLineApplication.IServiceProvider.GetService(Type)
    CommandLineApplication.Execute<TApp>(CommandLineContext)
    CommandLineApplication.ExecuteAsync<TApp>(CommandLineContext, CancellationToken)
    CommandLineApplication.Execute<TApp>(String[])
    CommandLineApplication.Execute<TApp>(IConsole, String[])
    CommandLineApplication.ExecuteAsync<TApp>(String[])
    CommandLineApplication.ExecuteAsync<TApp>(String[], CancellationToken)
    CommandLineApplication.ExecuteAsync<TApp>(IConsole, String[])
    CommandLineApplication.ValidationErrorHandler
    CommandLineApplication.Validators
    CommandLineApplication.GetValidationResult()
    Namespace: McMaster.Extensions.CommandLineUtils
    Assembly: McMaster.Extensions.CommandLineUtils.dll
    Syntax
    public class CommandLineApplication<TModel> : CommandLineApplication, IServiceProvider, IDisposable, IModelAccessor where TModel : class
    Type Parameters
    Name Description
    TModel

    Constructors

    | Improve this Doc View Source

    CommandLineApplication()

    Initializes a new instance of CommandLineApplication<TModel>.

    Declaration
    public CommandLineApplication()
    | Improve this Doc View Source

    CommandLineApplication(IHelpTextGenerator, IConsole, String)

    This constructor is obsolete and will be removed in a future version. The recommended replacement is CommandLineApplication(IHelpTextGenerator, IConsole, String)

    Initializes a new instance of CommandLineApplication<TModel>.

    Declaration
    public CommandLineApplication(IHelpTextGenerator helpTextGenerator, IConsole console, string workingDirectory)
    Parameters
    Type Name Description
    IHelpTextGenerator helpTextGenerator

    The help text generator to use.

    IConsole console

    The console implementation to use.

    System.String workingDirectory

    The current working directory.

    | Improve this Doc View Source

    CommandLineApplication(IConsole)

    Initializes a new instance of CommandLineApplication<TModel>.

    Declaration
    public CommandLineApplication(IConsole console)
    Parameters
    Type Name Description
    IConsole console

    The console implementation to use.

    | Improve this Doc View Source

    CommandLineApplication(IConsole, String)

    Initializes a new instance of CommandLineApplication<TModel>.

    Declaration
    public CommandLineApplication(IConsole console, string workingDirectory)
    Parameters
    Type Name Description
    IConsole console

    The console implementation to use.

    System.String workingDirectory

    The current working directory.

    Properties

    | Improve this Doc View Source

    Model

    An instance of the model associated with the command line application.

    Declaration
    public TModel Model { get; }
    Property Value
    Type Description
    TModel
    | Improve this Doc View Source

    ModelFactory

    Defines the function that produces an instance of TModel.

    Declaration
    public Func<TModel> ModelFactory { get; set; }
    Property Value
    Type Description
    System.Func<TModel>

    Methods

    | Improve this Doc View Source

    CreateModel()

    Create an instance of TModel.

    Declaration
    protected virtual TModel CreateModel()
    Returns
    Type Description
    TModel

    An instance of the context.

    | Improve this Doc View Source

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    CommandLineApplication.Dispose()

    Explicit Interface Implementations

    | Improve this Doc View Source

    IModelAccessor.GetModel()

    Declaration
    object IModelAccessor.GetModel()
    Returns
    Type Description
    System.Object
    | Improve this Doc View Source

    IModelAccessor.GetModelType()

    Declaration
    Type IModelAccessor.GetModelType()
    Returns
    Type Description
    System.Type

    Implements

    System.IServiceProvider
    System.IDisposable
    IModelAccessor

    Extension Methods

    CommandLineApplicationExtensions.Argument<T>(CommandLineApplication, String, String, Boolean)
    CommandLineApplicationExtensions.Option<T>(CommandLineApplication, String, String, CommandOptionType)
    CommandLineApplicationExtensions.Option<T>(CommandLineApplication, String, String, CommandOptionType, Boolean)
    CommandLineApplicationExtensions.Option<T>(CommandLineApplication, String, String, CommandOptionType, Action<CommandOption>)
    CommandLineApplicationExtensions.HelpOption(CommandLineApplication)
    CommandLineApplicationExtensions.HelpOption(CommandLineApplication, Boolean)
    CommandLineApplicationExtensions.VerboseOption(CommandLineApplication)
    CommandLineApplicationExtensions.VerboseOption(CommandLineApplication, String)
    CommandLineApplicationExtensions.OnExecuteAsync(CommandLineApplication, Func<CancellationToken, Task>)
    CommandLineApplicationExtensions.OnExecute(CommandLineApplication, Action)
    CommandLineApplicationExtensions.OnValidationError(CommandLineApplication, Func<ValidationResult, Int32>)
    CommandLineApplicationExtensions.OnValidationError(CommandLineApplication, Action<ValidationResult>)
    CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, Assembly)
    CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, String, Assembly)
    ValidationExtensions.OnValidate(CommandLineApplication, Func<ValidationContext, ValidationResult>)
    • Improve this Doc
    • View Source
    In This Article
    Back to top