Lenguaje

Option Clase

Definición

Espacio de nombres:
System.CommandLine
Ensamblado:
System.CommandLine.dll
Paquete:
System.CommandLine v3.0.0-rc.1.26425.128
Paquete:
System.CommandLine.Experimental v0.3.0-alpha.19577.1
Source:
Option.cs
Source:
Option.cs
Source:
Option.cs

Símbolo que define un parámetro con nombre y un valor para ese 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
Herencia
Object
Symbol
Option
Derivado
Implementaciones
IValueDescriptor IOption ISuggestionSource ISymbol

Constructores

Nombre Description
Option(String, String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
Option(String, String[])

Inicializa una nueva instancia de la clase Option.
Option(String[], String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

Propiedades

Nombre Description
Action

Obtiene o establece el para CommandLineAction la opción . El controlador representa la acción que se realizará cuando se invoque la opción.
Aliases

Obtiene el conjunto único de cadenas que se pueden usar en la línea de comandos para especificar la opción.
Aliases

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
AllowMultipleArgumentsPerToken

Obtiene un valor que indica si se permiten varios tokens de argumento para cada token de identificador de opción.
Argument

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
Arity

Obtiene o establece la aridad de la opción.
Children

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
CompletionSources

Obtiene la lista de orígenes de finalización de la opción .
Description

Obtiene o establece la descripción del símbolo.

(Heredado de Symbol)
HasDefaultValue

Especifica si se define un valor predeterminado para la opción .
HelpName

Obtiene o establece el nombre del marcador de posición que se muestra en la ayuda de uso para el valor de la opción. El valor se ajustará entre corchetes angulares (< y >).
Hidden

Obtiene o establece un valor que indica si el símbolo está oculto.

(Heredado de Symbol)
IsHidden

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
Name

Obtiene el nombre del símbolo.

(Heredado de Symbol)
Parents

Obtiene los símbolos primarios.

(Heredado de Symbol)
RawAliases

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
Recursive

Cuando se establece en true, esta opción se aplicará a su comando o comandos primarios inmediatos y de forma recursiva a sus subcomandos.
Required

Indica si la opción es necesaria cuando se invoca su comando primario.
Validators

Validadores a los que se llamará cuando el analizador coincida con la opción.
ValueType

Obtiene al Type que se convertirán los tokens analizados de la opción.

Métodos

Nombre Description
AddAlias(String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
AddAliasInner(String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

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

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
ClearAliases()

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
GetCompletions(CompletionContext)

Obtiene finalizaciones para el símbolo.
GetDefaultValue()

Obtiene el valor predeterminado de la opción .
HasAlias(String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
HasRawAlias(String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
Suggest(String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Symbol)

Implementaciones de interfaz explícitas

Nombre Description
IOption.Argument

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
ISymbol.Children

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

(Heredado de Symbol)
IValueDescriptor.GetDefaultValue()

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
IValueDescriptor.HasDefaultValue

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
IValueDescriptor.Type

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
IValueDescriptor.ValueName

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

Métodos de extensión

Nombre Description
BuildAlias(IValueDescriptor)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.
Parse(Option, String)

Símbolo que define un parámetro con nombre y un valor para ese parámetro.

Se aplica a