Idioma

HelpOption Classe

Definição

Espaço de Nomes:
System.CommandLine.Help
Assemblagem:
System.CommandLine.dll
Pacote:
System.CommandLine v3.0.0
Pacote:
System.CommandLine.Experimental v0.3.0-alpha.19577.1
Origem:
HelpOption.cs
Origem:
HelpOption.cs

Deve ser apresentada uma opção padrão que indique que ajuda na linha de comandos.

public ref class HelpOption sealed : System::CommandLine::Option
public sealed class HelpOption : System.CommandLine.Option
type HelpOption = class
    inherit Option
Public NotInheritable Class HelpOption
Inherits Option
Herança
Object
Symbol
Option
HelpOption

Construtores

Nome Descrição
HelpOption()

Quando adicionado a um Command, configura a aplicação para mostrar ajuda quando uma das seguintes opções é especificada na linha de comandos:

-h
/h
--help
-?
/?
HelpOption(String, String[])

Quando adicionado a um Command, configura a aplicação para mostrar ajuda quando o nome próprio ou um dos pseudónimos são especificados na linha de comandos.

Propriedades

Nome Descrição
Action

Recebe ou define a CommandLineAction opção. O handler representa a ação que será realizada quando a Opção for invocada.
Aliases

Obtém o conjunto único de cadeias que podem ser usadas na linha de comandos para especificar a Opção.

(Herdado de Option)
AllowMultipleArgumentsPerToken

Obtém um valor que indica se múltiplos tokens de argumento são permitidos para cada token identificador de opção.

(Herdado de Option)
Arity

Obtém ou define a aridade da opção.

(Herdado de Option)
CompletionSources

Obtém a lista de fontes de conclusão para a opção.

(Herdado de Option)
Description

Obtém ou define a descrição do símbolo.

(Herdado de Symbol)
HasDefaultValue

Especifica se está definido um valor padrão para a opção.

(Herdado de Option)
HelpName

Obtém ou define o nome provisório mostrado na ajuda de utilização para o valor da opção. O valor será enrolado entre colchetes angulares (< e >).

(Herdado de Option)
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)
Parents

Fica com os símbolos pais.

(Herdado de Symbol)
Recursive

Quando definida como true, esta opção será aplicada ao comando ou comandos pais imediatos e recursivamente aos seus subcomandos.

(Herdado de Option)
Required

Indica se a opção é necessária quando o comando pai é invocado.

(Herdado de Option)
Validators

Validadores que serão chamados quando a opção for correspondida pelo parser.

(Herdado de Option)
ValueType

Deve ser apresentada uma opção padrão que indique que ajuda na linha de comandos.

Métodos

Nome Descrição
GetCompletions(CompletionContext)

Obtém conclusãos para o símbolo.

(Herdado de Option)
GetDefaultValue()

Obtém o valor padrão da opção.

(Herdado de Option)
ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Symbol)

Propriedades de Extensão

Nome Descrição
IsDynamic

Indica se esta opção requer uma chamada dinâmica de retorno à própria aplicação (através da diretiva incorporada [suggest] ) para calcular as completações no momento da conclusão.

Métodos da Extensão

Nome Descrição
IsFlag(Option)

Deve ser apresentada uma opção padrão que indique que ajuda na linha de comandos.
Names(Option)

Obtenha todos os nomes de uma opção, incluindo o nome principal e todos os pseudónimos
PrimaryNameAndAliases(Option)

Deve ser apresentada uma opção padrão que indique que ajuda na linha de comandos.

Aplica-se a