Option Classe

Définition

Espace de noms:

System.CommandLine

Assembly:

System.CommandLine.dll

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

public ref class Option : System::CommandLine::IdentifierSymbol, System::CommandLine::Binding::IValueDescriptor

public class Option : System.CommandLine.IdentifierSymbol, System.CommandLine.Binding.IValueDescriptor

type Option = class
    inherit IdentifierSymbol
    interface IValueDescriptor

Public Class Option
Inherits IdentifierSymbol
Implements IValueDescriptor

Héritage

Object

Symbol

IdentifierSymbol

Option

Dérivé

System.CommandLine.Option<T>

Implémente

IValueDescriptor

Constructeurs

Option(String, String, Type, Func<Object>, ArgumentArity)	Initialise une nouvelle instance de la classe Option.
Option(String[], String, Type, Func<Object>, ArgumentArity)	Initialise une nouvelle instance de la classe Option.

Propriétés

Aliases	Obtient l’ensemble de chaînes qui peuvent être utilisées sur la ligne de commande pour spécifier le symbole. (Hérité de IdentifierSymbol)
AllowMultipleArgumentsPerToken	Obtient une valeur qui indique si plusieurs jetons d’argument sont autorisés pour chaque jeton d’identificateur d’option.
ArgumentHelpName	Obtient ou définit le nom de l’argument lorsqu’il est affiché dans l’aide.
Arity	Obtient ou définit l’arité de l’option.
Description	Obtient ou définit la description du symbole. (Hérité de Symbol)
IsHidden	Obtient ou définit une valeur indiquant si le symbole est masqué. (Hérité de Symbol)
IsRequired	Indique si l’option est requise lorsque sa commande parente est appelée.
Name	Obtient ou définit le nom du symbole.
Parents	Obtient les symboles parent. (Hérité de Symbol)
ValueType	Type que les arguments de l’option sont censés être analysés comme.

Méthodes

AddAlias(String)	Ajoute un alias. (Hérité de IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)	Ajoute un validateur qui sera appelé lorsque l’option est mise en correspondance par l’analyseur.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetCompletions()	Obtient des achèvements pour le symbole. (Hérité de Symbol)
GetCompletions(CompletionContext)	Obtient les valeurs suggérées pour l’achèvement de la ligne de commande.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
HasAlias(String)	Détermine si l’alias a déjà été défini. (Hérité de IdentifierSymbol)
HasAliasIgnoringPrefix(String)	Indique si un alias donné existe sur l’option, quel que soit son préfixe.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
SetDefaultValue(Object)	Définit la valeur par défaut de l’option.
SetDefaultValueFactory(Func<Object>)	Définit un délégué à appeler lorsque la valeur par défaut de l’option est requise.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Symbol)

Implémentations d’interfaces explicites

IValueDescriptor.GetDefaultValue()	Obtient la valeur par défaut, le cas échéant.
IValueDescriptor.HasDefaultValue	Obtient une valeur qui indique s’il existe une valeur par défaut.
IValueDescriptor.ValueName	Obtient le nom de la valeur.

Méthodes d’extension

Parse(Option, String)	Analyse une valeur de chaîne de ligne de commande à l’aide d’une option.
Parse(Option, String[])	Analyse une valeur de chaîne de ligne de commande à l’aide d’une option.

Voir aussi

• IdentifierSymbol