HelpOption 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.
Deve ser apresentada uma opção padrão que indique que ajuda na linha de comandos.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Herança
Construtores
| Name | 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: |
| 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
| Name | 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 ( |
| 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
| Name | 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) |
