Option Classe

Définition

Espace de noms:

System.CommandLine

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v3.0.0-rc.1.26425.128

Source:

Option.cs

Symbole définissant un paramètre nommé et une valeur pour ce paramètre.

public ref class Option abstract : System::CommandLine::Symbol

public abstract class Option : System.CommandLine.Symbol

type Option = class
    inherit Symbol

Public MustInherit Class Option
Inherits Symbol

Héritage

Object

Symbol

Option

Dérivé

System.CommandLine.Help.HelpOption

System.CommandLine.Option<T>

System.CommandLine.VersionOption

Constructeurs

Nom	Description
Option(String, String[])	Initialise une nouvelle instance de la classe Option.

Propriétés

Nom	Description
Action	Obtient ou définit l’option CommandLineAction . Le gestionnaire représente l’action qui sera effectuée lorsque l’option est appelée.
Aliases	Obtient l’ensemble unique de chaînes qui peuvent être utilisées sur la ligne de commande pour spécifier l’option.
AllowMultipleArgumentsPerToken	Obtient une valeur qui indique si plusieurs jetons d’argument sont autorisés pour chaque jeton d’identificateur d’option.
Arity	Obtient ou définit l’arité de l’option.
CompletionSources	Obtient la liste des sources d’achèvement de l’option.
Description	Obtient ou définit la description du symbole. (Hérité de Symbol)
HasDefaultValue	Spécifie si une valeur par défaut est définie pour l’option.
HelpName	Obtient ou définit le nom de l’espace réservé affiché dans l’aide d’utilisation pour la valeur de l’option. La valeur est encapsulée entre crochets d’angle (< et >).
Hidden	Obtient ou définit une valeur indiquant si le symbole est masqué. (Hérité de Symbol)
Name	Obtient le nom du symbole. (Hérité de Symbol)
Parents	Obtient les symboles parents. (Hérité de Symbol)
Recursive	Lorsqu’elle est définie sur true, cette option est appliquée à sa commande parente immédiate ou à ses commandes et récursivement à leurs sous-commandes.
Required	Indique si l’option est requise lorsque sa commande parente est appelée.
Validators	Validateurs qui seront appelés lorsque l’option est mise en correspondance par l’analyseur.
ValueType	Obtient le Type jeton analysé par l’option vers lequel les jetons sont convertis.

Méthodes

Nom	Description
GetCompletions(CompletionContext)	Obtient les achèvements du symbole.
GetDefaultValue()	Obtient la valeur par défaut de l’option.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Symbol)