Class CommandLineApplication<TModel>

Namespace

McMaster.Extensions.CommandLineUtils

Assembly

McMaster.Extensions.CommandLineUtils.dll

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

public class CommandLineApplication<TModel> : CommandLineApplication, IServiceProvider, IDisposable, IModelAccessor where TModel : class

Type Parameters

TModel

Inheritance

object

CommandLineApplication

CommandLineApplication<TModel>

Implements

IServiceProvider

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, bool)

CommandLineApplication.Option(string, string, CommandOptionType, Action<CommandOption>)

CommandLineApplication.Option(string, string, CommandOptionType, Action<CommandOption>, bool)

CommandLineApplication.AddOption(CommandOption)

CommandLineApplication.Option<T>(string, string, CommandOptionType, Action<CommandOption<T>>, bool)

CommandLineApplication.Argument(string, string, bool)

CommandLineApplication.Argument(string, string, Action<CommandArgument>, bool)

CommandLineApplication.Argument<T>(string, string, Action<CommandArgument<T>>, bool)

CommandLineApplication.AddArgument(CommandArgument)

CommandLineApplication.OnExecute(Func<int>)

CommandLineApplication.OnExecuteAsync(Func<CancellationToken, Task<int>>)

CommandLineApplication.OnParsingComplete(Action<ParseResult>)

CommandLineApplication.Parse(params string[])

CommandLineApplication.MakeSuggestionsInErrorMessage

CommandLineApplication.HandleParseResult(ParseResult)

CommandLineApplication.Execute(params string[])

CommandLineApplication.ExecuteAsync(string[], CancellationToken)

CommandLineApplication.HelpOption(string)

CommandLineApplication.HelpOption(string, bool)

CommandLineApplication.VersionOption(string, string, string)

CommandLineApplication.VersionOption(string, Func<string>, Func<string>)

CommandLineApplication.ShowHint()

CommandLineApplication.ShowHelp()

CommandLineApplication.ShowHelp(bool)

CommandLineApplication.GetHelpText()

CommandLineApplication.ShowVersion()

CommandLineApplication.GetVersionText()

CommandLineApplication.GetFullNameAndVersion()

CommandLineApplication.ShowRootCommandFullNameAndVersion()

CommandLineApplication.Conventions

CommandLineApplication.Execute<TApp>(CommandLineContext)

CommandLineApplication.ExecuteAsync<TApp>(CommandLineContext, CancellationToken)

CommandLineApplication.Execute<TApp>(params string[])

CommandLineApplication.Execute<TApp>(IConsole, params string[])

CommandLineApplication.ExecuteAsync<TApp>(params string[])

CommandLineApplication.ExecuteAsync<TApp>(string[], CancellationToken)

CommandLineApplication.ExecuteAsync<TApp>(IConsole, params string[])

CommandLineApplication.ValidationErrorHandler

CommandLineApplication.Validators

CommandLineApplication.GetValidationResult()

Extension Methods

CommandLineApplicationExtensions.Argument<T>(CommandLineApplication, string, string, bool)

CommandLineApplicationExtensions.HelpOption(CommandLineApplication)

CommandLineApplicationExtensions.HelpOption(CommandLineApplication, bool)

CommandLineApplicationExtensions.OnExecute(CommandLineApplication, Action)

CommandLineApplicationExtensions.OnExecuteAsync(CommandLineApplication, Func<CancellationToken, Task>)

CommandLineApplicationExtensions.OnValidationError(CommandLineApplication, Action<ValidationResult>)

CommandLineApplicationExtensions.OnValidationError(CommandLineApplication, Func<ValidationResult, int>)

CommandLineApplicationExtensions.Option<T>(CommandLineApplication, string, string, CommandOptionType)

CommandLineApplicationExtensions.Option<T>(CommandLineApplication, string, string, CommandOptionType, Action<CommandOption<T>>)

CommandLineApplicationExtensions.Option<T>(CommandLineApplication, string, string, CommandOptionType, bool)

CommandLineApplicationExtensions.VerboseOption(CommandLineApplication)

CommandLineApplicationExtensions.VerboseOption(CommandLineApplication, string)

CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, Assembly)

CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, string, Assembly)

ValidationExtensions.OnValidate(CommandLineApplication, Func<ValidationContext, ValidationResult>)

Constructors

CommandLineApplication()

Initializes a new instance of CommandLineApplication<TModel>.

public CommandLineApplication()

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

public CommandLineApplication(IHelpTextGenerator helpTextGenerator, IConsole console, string workingDirectory)

Parameters

helpTextGenerator IHelpTextGenerator

The help text generator to use.

console IConsole

The console implementation to use.

workingDirectory string

The current working directory.

CommandLineApplication(IConsole)

Initializes a new instance of CommandLineApplication<TModel>.

public CommandLineApplication(IConsole console)

Parameters

console IConsole

The console implementation to use.

CommandLineApplication(IConsole, string)

Initializes a new instance of CommandLineApplication<TModel>.

public CommandLineApplication(IConsole console, string workingDirectory)

Parameters

console IConsole

The console implementation to use.

workingDirectory string

The current working directory.

Properties

Model

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

public TModel Model { get; }

Property Value

TModel

ModelFactory

Defines the function that produces an instance of TModel.

public Func<TModel> ModelFactory { get; set; }

Property Value

Func<TModel>

Methods

CreateModel()

Create an instance of TModel.

protected virtual TModel CreateModel()

Returns

TModel

An instance of the context.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public override void Dispose()