RootCommand Classe

Definição

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Representa a ação main que o aplicativo executa.

public ref class RootCommand : System::CommandLine::Command

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Herança

Object

Symbol

IdentifierSymbol

Command

RootCommand

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 para aplicativos com várias ações.

Construtores

RootCommand(String)

Representa a ação main que o aplicativo executa.

Propriedades

Aliases	Obtém o conjunto de cadeias de caracteres que podem ser usadas na linha de comando para especificar o símbolo. (Herdado de IdentifierSymbol)
Arguments	Representa 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)
ExecutableName	O nome do executável em execução no momento.
ExecutablePath	O caminho para o executável em execução no momento.
Handler	Obtém ou define o ICommandHandler para o comando . O manipulador representa a ação que será executada quando o comando for invocado. (Herdado de Command)
IsHidden	Obtém ou define um valor que indica se o símbolo está oculto. (Herdado de Symbol)
Name	Obtém ou define o nome do símbolo. (Herdado de IdentifierSymbol)
Options	Representa todas as opções para o comando, incluindo opções globais que foram aplicadas a qualquer um dos ancestrais do comando. (Herdado de Command)
Parents	Obtém os símbolos pai. (Herdado de Symbol)
Subcommands	Representa todos os subcomandos para o comando . (Herdado de Command)
TreatUnmatchedTokensAsErrors	Obtém ou define um valor que indica se tokens não correspondentes devem ser tratados como erros. Por exemplo, se definido true como e um comando ou argumento extra for fornecido, a validação falhará. (Herdado de Command)

Métodos

Add(Argument)	Adiciona um Argument ao comando . (Herdado de Command)
Add(Command)	Adiciona um subcomando ao comando . (Herdado de Command)
Add(Option)	Adiciona um Option ao comando . (Herdado de Command)
AddAlias(String)	Adiciona um alias. (Herdado de IdentifierSymbol)
AddArgument(Argument)	Adiciona um Argument ao comando . (Herdado de Command)
AddCommand(Command)	Adiciona um subcomando ao comando . (Herdado de Command)
AddGlobalOption(Option)	Adiciona um global Option ao comando . (Herdado de Command)
AddOption(Option)	Adiciona um Option ao comando . (Herdado de Command)
AddValidator(ValidateSymbolResult<CommandResult>)	Adiciona um validador personalizado ao comando . Os validadores podem ser usados para criar uma lógica de validação personalizada. (Herdado de Command)
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetCompletions()	Obtém conclusões para o símbolo. (Herdado de Symbol)
GetCompletions(CompletionContext)	Obtém os valores sugeridos para conclusão da linha de comando. (Herdado de Command)
GetEnumerator()	Obtém um enumerador que representa todos os símbolos do comando. (Herdado de Command)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
HasAlias(String)	Determina se o alias já foi definido. (Herdado de IdentifierSymbol)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Symbol)

Implantações explícitas de interface

IEnumerable.GetEnumerator()

Retorna um enumerador que itera em uma coleção. (Herdado de Command)

Métodos de Extensão

Invoke(Command, String, IConsole)	Analisa e invoca um comando.
Invoke(Command, String[], IConsole)	Analisa e invoca um comando.
InvokeAsync(Command, String, IConsole)	Analisa e invoca um comando.
InvokeAsync(Command, String[], IConsole)	Analisa e invoca um comando.
Parse(Command, String)	Analisa um valor de cadeia de caracteres de linha de comando usando o comando especificado.
Parse(Command, String[])	Analisa uma cadeia de caracteres de matriz usando o comando especificado.
SetHandler(Command, Action)	Define o manipulador de um comando com base em um Action.
SetHandler(Command, Func<Task>)	Define o manipulador de um comando com base em um Func<TResult>.
SetHandler<T>(Command, Action<T>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T>.
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>.
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2>.
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,TResult>.
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3>.
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,TResult>.
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4>.
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,TResult>.
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5>.
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])	Define o manipulador de um comando com base em um Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])	Define o manipulador de um comando com base em um Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>.