RootCommand Classe

Definição

Espaço de Nomes:

System.CommandLine

Assemblagem:

System.CommandLine.dll

Pacote:

System.CommandLine v3.0.0-preview.4.26230.115

Origem:

RootCommand.cs

Representa a principal ação que a aplicação realiza.

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

Command

RootCommand

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

Name	Description
RootCommand(String)	Representa a principal ação que a aplicação realiza.

Propriedades

Name	Description
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)
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.
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)
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)
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

Name	Description
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)
GetCompletions(CompletionContext)	Obtém conclusãos para o símbolo. (Herdado de Command)
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)
ToString()	Devolve uma cadeia que representa o objeto atual. (Herdado de Symbol)

Implementações de Interface Explícita

Name	Description
IEnumerable.GetEnumerator()	Devolve um enumerador que itera numa coleção. (Herdado de Command)