RootCommand Classe

Definição

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Pacote:

System.CommandLine v3.0.0-preview.1.26104.118

Origem:

RootCommand.cs

Representa a ação principal executada pelo aplicativo.

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

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)
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.
Hidden	Obtém ou define um valor que indica se o símbolo está oculto. (Herdado de Symbol)
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)
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)
GetCompletions(CompletionContext)	Obtém conclusões para o símbolo. (Herdado de Command)
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)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Symbol)

Implantações explícitas de interface

Nome	Description
IEnumerable.GetEnumerator()	Retorna um enumerador que itera por meio de uma coleção. (Herdado de Command)