Idioma

Option<T> 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{T}.cs
Origem:
Option{T}.cs
Origem:
Option{T}.cs

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

generic <typename T>
public ref class Option : System::CommandLine::Option
public class Option<T> : System.CommandLine.Option
type Option<'T> = class
    inherit Option
Public Class Option(Of T)
Inherits Option

Parâmetros de Tipo Genérico

T

Os Type argumentos da opção são esperados a ser analisados como.

Herança
Object
Symbol
Option
Option<T>

Construtores

Nome Descrição
Option<T>(String, String)

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

Inicializa uma nova instância da Option classe.
Option<T>(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.

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

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

(Herdado de Option)
CustomParser

Obtém ou define um parser de argumentos personalizado.
DefaultValueFactory

Obtém ou define o delegado a invocar para criar o valor padrã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.

(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)
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.

(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

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

Métodos

Nome Descrição
AcceptLegalFileNamesOnly()

Configura a opção para aceitar apenas valores que representam nomes legais de ficheiros.
AcceptLegalFilePathsOnly()

Configura a opção para aceitar apenas valores que representam os caminhos legais dos ficheiros.
AcceptOnlyFromAmong(String[])

Configura a opção para aceitar apenas os valores especificados e sugeri-los como conclusãos na linha de comandos.
AcceptOnlyFromAmong(StringComparer, String[])

Configura a opção para aceitar apenas os valores especificados usando o comparador especificado, e para os sugerir como completações na linha de comandos.
AddAlias(String)

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

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

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

(Herdado de Option)
GetDefaultValue()

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

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

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

(Herdado de Option)
IValueDescriptor.HasDefaultValue

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

(Herdado de Option)
IValueDescriptor.Type

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

(Herdado de Option)
IValueDescriptor.ValueName

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

(Herdado de Option)

Métodos da Extensão

Nome Descrição
AcceptExistingOnly<T>(Option<T>)

Configura uma opção para aceitar apenas valores correspondentes a ficheiros ou diretórios existentes.
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