RootCommand Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Representa a principal ação que a aplicação realiza.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Herança
Observações
Use o objeto RootCommand sem subcomandos para aplicações que realizam uma única ação. Adicione subcomandos à raiz para aplicações que requerem ações identificadas por strings específicas. Por exemplo, 'dir' não utiliza subcomandos. Veja Command aplicações com múltiplas ações.
Construtores
| Nome | Descrição |
|---|---|
| RootCommand(String) |
Representa a principal ação que a aplicação realiza. |
Propriedades
| Nome | Descrição |
|---|---|
| Action |
Recebe ou define o CommandLineAction para o Comando. O handler representa a ação que será executada quando o Comando for invocado. (Herdado de Command) |
| Aliases |
Obtém o conjunto único de cadeias que podem ser usadas na linha de comandos para especificar o comando. (Herdado de Command) |
| Argument |
Obsoleto.
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| Arguments |
Recebe todos os argumentos a favor do comando. (Herdado de Command) |
| Children |
Fica com os símbolos da criança. (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. |
| ExecutablePath |
O caminho para o executável em curso. |
| ExeName |
Representa a principal ação que a aplicação realiza. |
| ExePath |
Representa a principal ação que a aplicação realiza. |
| Handler |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| HelpName |
Recebe ou define o nome usado para o comando raiz na saída de ajuda. |
| Hidden |
Recebe ou define um valor que indica se o símbolo está oculto. (Herdado de Symbol) |
| IsHidden |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| Name |
Representa a principal ação que a aplicação realiza. |
| Name |
Recebe o nome do símbolo. (Herdado de Symbol) |
| Options |
Obtém todas as opções para o comando. (Herdado de Command) |
| Parents |
Fica com os símbolos pais. (Herdado de Symbol) |
| RawAliases |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| Subcommands |
Recebe todos os subcomandos do comando. (Herdado de Command) |
| TreatUnmatchedTokensAsErrors |
Recebe ou define um valor que indica se os tokens não combinados devem ser tratados como erros. (Herdado de Command) |
| Validators |
Faz com que os validadores cheguem ao comando. Validadores podem ser usados para criar lógica de validação personalizada. (Herdado de Command) |
Métodos
| Nome | Descrição |
|---|---|
| Add(Argument) |
Adiciona um a Argument ao comando. (Herdado de Command) |
| Add(Command) |
Adiciona um a Command ao comando. (Herdado de Command) |
| Add(Directive) |
Adiciona um a Directive ao comando. |
| Add(Option) |
Adiciona um 'an' Option ao comando. (Herdado de Command) |
| Add(Symbol) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| AddAlias(String) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| AddAliasInner(String) |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| AddArgument(Argument) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| AddCommand(Command) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| AddOption(Option) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| ClearAliases() |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| GetCompletions(CompletionContext) |
Obtém conclusãos para o símbolo. (Herdado de Command) |
| GetEnumerator() |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| HasAlias(String) |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| HasRawAlias(String) |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analisa as cadeias de um array usando o comando. (Herdado de Command) |
| Parse(String, ParserConfiguration) |
Analisa um valor de cadeia de linhas de comandos 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 principal ação que a aplicação realiza. (Herdado de Symbol) |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Symbol) |
Implementações de Interface Explícita
| Nome | Descrição |
|---|---|
| ICommand.Argument |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| ICommand.Arguments |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| ICommand.Options |
Representa a principal ação que a aplicação realiza. (Herdado de Command) |
| IEnumerable.GetEnumerator() |
Devolve um enumerador que itera numa coleção. (Herdado de Command) |
| ISymbol.Children |
Representa a principal ação que a aplicação realiza. (Herdado de Symbol) |
Métodos da Extensão
| Nome | Descrição |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Representa a principal ação que a aplicação realiza. |
| Invoke(Command, String, IConsole) |
Representa a principal ação que a aplicação realiza. |
| Invoke(Command, String[], IConsole) |
Representa a principal ação que a aplicação realiza. |
| InvokeAsync(Command, String, IConsole) |
Representa a principal ação que a aplicação realiza. |
| InvokeAsync(Command, String[], IConsole) |
Representa a principal ação que a aplicação realiza. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Representa a principal ação que a aplicação realiza. |
| Parse(Command, String[]) |
Representa a principal ação que a aplicação realiza. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Converte um IEnumerable<T> para um IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Cria um FrozenDictionary<TKey,TValue> a partir de um IEnumerable<T> de acordo com as funções seletoras de teclas e seletores de elementos especificadas. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Cria a FrozenDictionary<TKey,TValue> partir de uma IEnumerable<T> função seletora de teclas especificada. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Cria um FrozenSet<T> com os valores especificados. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Cria um array imutável a partir 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 do 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 do seu conteúdo usando o comparador de chaves 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 do seu conteúdo. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Constrói um dicionário imutável baseado numa 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 fonte. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Enumera uma sequência, produz um conjunto de hash imutável do seu conteúdo e utiliza 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 do seu conteúdo. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Enumera uma sequência e produz uma lista imutável do 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 ordenado imutável do 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 ordenado imutável do seu conteúdo usando o comparador de chaves especificado. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumera e transforma uma sequência, produzindo um dicionário ordenado imutável do seu conteúdo. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Enumera uma sequência, produz um conjunto ordenado imutável do seu conteúdo e utiliza o comparador especificado. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Enumera uma sequência e produz um conjunto ordenado imutável do seu conteúdo. |
| UseCommandHandler<THandler>(Command) |
Representa a principal ação que a aplicação realiza. |
