RootCommand Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa a ação principal executada pelo aplicativo.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Herança
Comentários
Use o objeto RootCommand sem subcomandos para aplicativos que executam uma ação. Adicione subcomandos à raiz para aplicativos que exigem ações identificadas por cadeias de caracteres específicas. Por exemplo, 'dir' não usa subcomandos. Consulte Command os aplicativos com várias ações.
Construtores
| Nome | Description |
|---|---|
| RootCommand(String) |
Representa a ação principal executada pelo aplicativo. |
Propriedades
| Nome | Description |
|---|---|
| Action |
Obtém ou define o CommandLineAction para o Comando. O manipulador representa a ação que será executada quando o Comando for invocado. (Herdado de Command) |
| Aliases |
Obtém o conjunto exclusivo de cadeias de caracteres que podem ser usadas na linha de comando para especificar o comando. (Herdado de Command) |
| Argument |
Obsoleto.
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| Arguments |
Obtém todos os argumentos para o comando. (Herdado de Command) |
| Children |
Obtém os símbolos filho. (Herdado de Command) |
| Description |
Obtém ou define a descrição do símbolo. (Herdado de Symbol) |
| Directives |
Representa todas as diretivas válidas sob o comando raiz. |
| ExecutableName |
O nome do executável em execução no momento. |
| ExecutablePath |
O caminho para o executável em execução no momento. |
| ExeName |
Representa a ação principal executada pelo aplicativo. |
| ExePath |
Representa a ação principal executada pelo aplicativo. |
| Handler |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| HelpName |
Obtém ou define o nome usado para o comando raiz na saída da ajuda. |
| Hidden |
Obtém ou define um valor que indica se o símbolo está oculto. (Herdado de Symbol) |
| IsHidden |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| Name |
Representa a ação principal executada pelo aplicativo. |
| Name |
Obtém o nome do símbolo. (Herdado de Symbol) |
| Options |
Obtém todas as opções para o comando. (Herdado de Command) |
| Parents |
Obtém os símbolos pai. (Herdado de Symbol) |
| RawAliases |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| Subcommands |
Obtém todos os subcomandos do comando. (Herdado de Command) |
| TreatUnmatchedTokensAsErrors |
Obtém ou define um valor que indica se tokens não compatíveis devem ser tratados como erros. (Herdado de Command) |
| Validators |
Obtém os validadores para o comando. Os validadores podem ser usados para criar uma lógica de validação personalizada. (Herdado de Command) |
Métodos
| Nome | Description |
|---|---|
| Add(Argument) |
Adiciona um Argument ao comando. (Herdado de Command) |
| Add(Command) |
Adiciona um Command ao comando. (Herdado de Command) |
| Add(Directive) |
Adiciona um Directive ao comando. |
| Add(Option) |
Adiciona um Option ao comando. (Herdado de Command) |
| Add(Symbol) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| AddAlias(String) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| AddAliasInner(String) |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| AddArgument(Argument) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| AddCommand(Command) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| AddOption(Option) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| ClearAliases() |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| GetCompletions(CompletionContext) |
Obtém conclusões para o símbolo. (Herdado de Command) |
| GetEnumerator() |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| HasAlias(String) |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| HasRawAlias(String) |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analisa uma cadeia de caracteres de matriz usando o comando. (Herdado de Command) |
| Parse(String, ParserConfiguration) |
Analisa um valor de cadeia de caracteres de linha de comando usando o comando. (Herdado de Command) |
| SetAction(Action<ParseResult>) |
Define uma ação síncrona a ser executada quando o comando é invocado. (Herdado de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Define uma ação assíncrona quando o comando é invocado. (Herdado de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Define uma ação assíncrona a ser executada quando o comando é invocado. (Herdado de Command) |
| SetAction(Func<ParseResult,Int32>) |
Define uma ação síncrona a ser executada quando o comando é invocado. (Herdado de Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Define uma ação assíncrona a ser executada quando o comando é invocado. (Herdado de Command) |
| SetAction(Func<ParseResult,Task>) |
Define uma ação assíncrona a ser executada quando o comando é invocado. (Herdado de Command) |
| Suggest(String) |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Symbol) |
Implantações explícitas de interface
| Nome | Description |
|---|---|
| ICommand.Argument |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| ICommand.Arguments |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| ICommand.Options |
Representa a ação principal executada pelo aplicativo. (Herdado de Command) |
| IEnumerable.GetEnumerator() |
Retorna um enumerador que itera por meio de uma coleção. (Herdado de Command) |
| ISymbol.Children |
Representa a ação principal executada pelo aplicativo. (Herdado de Symbol) |
Métodos de Extensão
| Nome | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Representa a ação principal executada pelo aplicativo. |
| Invoke(Command, String, IConsole) |
Representa a ação principal executada pelo aplicativo. |
| Invoke(Command, String[], IConsole) |
Representa a ação principal executada pelo aplicativo. |
| InvokeAsync(Command, String, IConsole) |
Representa a ação principal executada pelo aplicativo. |
| InvokeAsync(Command, String[], IConsole) |
Representa a ação principal executada pelo aplicativo. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Representa a ação principal executada pelo aplicativo. |
| Parse(Command, String[]) |
Representa a ação principal executada pelo aplicativo. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Converte um IEnumerable<T> em um IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Cria um FrozenDictionary<TKey,TValue> de uma IEnumerable<T> de acordo com as funções de seletor de elemento e seletor de elemento especificadas. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Cria uma FrozenDictionary<TKey,TValue> função de seletor de chave de IEnumerable<T> acordo com a especificada. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Cria um FrozenSet<T> com os valores especificados. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Cria uma matriz imutável da coleção especificada. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Enumera e transforma uma sequência e produz um dicionário imutável de seu conteúdo usando os comparadores de chave e valor especificados. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Enumera e transforma uma sequência e produz um dicionário imutável de seu conteúdo usando o comparador de chave especificado. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumera e transforma uma sequência e produz um dicionário imutável de seu conteúdo. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Constrói um dicionário imutável com base em alguma transformação de uma sequência. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Constrói um dicionário imutável a partir de uma coleção existente de elementos, aplicando uma função de transformação às chaves de origem. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Enumera uma sequência, produz um conjunto de hash imutável de seu conteúdo e usa o comparador de igualdade especificado para o tipo de conjunto. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Enumera uma sequência e produz um conjunto de hash imutável de seu conteúdo. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Enumera uma sequência e produz uma lista imutável de seu conteúdo. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Enumera e transforma uma sequência e produz um dicionário classificado imutável de seu conteúdo usando os comparadores de chave e valor especificados. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Enumera e transforma uma sequência e produz um dicionário classificado imutável de seu conteúdo usando o comparador de chave especificado. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumera e transforma uma sequência e produz um dicionário classificado imutável de seu conteúdo. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Enumera uma sequência, produz um conjunto classificado imutável de seu conteúdo e usa o comparador especificado. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Enumera uma sequência e produz um conjunto classificado imutável de seu conteúdo. |
| UseCommandHandler<THandler>(Command) |
Representa a ação principal executada pelo aplicativo. |
