Idioma

Option Classe

Definição

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

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

public ref class Option abstract : System::CommandLine::Symbol
public ref class Option : System::CommandLine::Symbol, System::CommandLine::IOption
public abstract class Option : System.CommandLine.Symbol
public class Option : System.CommandLine.Symbol, System.CommandLine.IOption
type Option = class
    inherit Symbol
type Option = class
    inherit Symbol
    interface IOption
    interface ISymbol
    interface ISuggestionSource
    interface IValueDescriptor
Public MustInherit Class Option
Inherits Symbol
Public Class Option
Inherits Symbol
Implements IOption
Herança
Object
Symbol
Option
Derivado
Implementações
IValueDescriptor IOption ISuggestionSource ISymbol

Construtores

Nome Descrição
Option(String, String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
Option(String, String[])

Inicializa uma nova instância da Option classe.
Option(String[], String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

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.
Aliases

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
AllowMultipleArgumentsPerToken

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

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
Arity

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

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
CompletionSources

Obtém a lista de fontes de conclusão para a opção.
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.
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 >).
Hidden

Recebe ou define um valor que indica se o símbolo está oculto.

(Herdado de Symbol)
IsHidden

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
Name

Recebe o nome do símbolo.

(Herdado de Symbol)
Parents

Fica com os símbolos pais.

(Herdado de Symbol)
RawAliases

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
Recursive

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

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

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

Obtém Type que os tokens analisados da opção serão convertidos.

Métodos

Nome Descrição
AddAlias(String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
AddAliasInner(String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
AddValidator(ValidateSymbol<OptionResult>)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
ClearAliases()

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
GetCompletions(CompletionContext)

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

Obtém o valor padrão da opção.
HasAlias(String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
HasRawAlias(String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
Suggest(String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Symbol)

Implementações de Interface Explícita

Nome Descrição
IOption.Argument

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
ISymbol.Children

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

(Herdado de Symbol)
IValueDescriptor.GetDefaultValue()

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
IValueDescriptor.HasDefaultValue

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
IValueDescriptor.Type

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
IValueDescriptor.ValueName

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

Métodos da Extensão

Nome Descrição
BuildAlias(IValueDescriptor)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.
Parse(Option, String)

Um símbolo que define um parâmetro nomeado e um valor para esse parâmetro.

Aplica-se a