Idioma

Option Classe

Definição

Namespace:
System.CommandLine
Assembly:
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 Description
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 classe Option.
Option(String[], String)

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

Propriedades

Nome Description
Action

Obtém ou define o CommandLineAction para a opção. O manipulador representa a ação que será executada quando a opção for invocada.
Aliases

Obtém o conjunto exclusivo de cadeias de caracteres que podem ser usadas na linha de comando 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 vários tokens de argumento são permitidos para cada token de 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 um valor padrão é definido para a opção.
HelpName

Obtém ou define o nome do espaço reservado mostrado na ajuda de uso para o valor da opção. O valor será encapsulado em colchetes angulares (< e >).
Hidden

Obtém 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

Obtém o nome do símbolo.

(Herdado de Symbol)
Parents

Obtém os símbolos pai.

(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 definido como true, essa opção será aplicada a seu comando ou comando pai imediato e recursivamente aos subcomandos.
Required

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

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

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

Métodos

Nome Description
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ões 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()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Symbol)

Implantações explícitas de interface

Nome Description
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 de Extensão

Nome Description
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