Option<T> Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert.
generic <typename T>
public ref class Option : System::CommandLine::Optionpublic class Option<T> : System.CommandLine.Optiontype Option<'T> = class
inherit OptionPublic Class Option(Of T)
Inherits OptionTypparameter
- T
Es Type wird erwartet, dass die Argumente der Option analysiert werden.
- Vererbung
Konstruktoren
| Name | Beschreibung |
|---|---|
| Option<T>(String, String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. |
| Option<T>(String, String[]) |
Initialisiert eine neue Instanz der Option-Klasse. |
| Option<T>(String[], String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| Action |
Dient zum Abrufen oder Festlegen des CommandLineAction Werts für die Option. Der Handler stellt die Aktion dar, die ausgeführt wird, wenn die Option aufgerufen wird. (Geerbt von Option) |
| Aliases |
Ruft den eindeutigen Satz von Zeichenfolgen ab, die in der Befehlszeile verwendet werden können, um die Option anzugeben. (Geerbt von Option) |
| AllowMultipleArgumentsPerToken |
Ruft einen Wert ab, der angibt, ob mehrere Argumenttoken für jedes Optionsbezeichnertoken zulässig sind. (Geerbt von Option) |
| Argument |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. |
| Arity |
Ruft ab oder legt die Arität der Option fest. (Geerbt von Option) |
| Children |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| CompletionSources |
Ruft die Liste der Abschlussquellen für die Option ab. (Geerbt von Option) |
| CustomParser |
Dient zum Abrufen oder Festlegen eines benutzerdefinierten Argumentparsers. |
| DefaultValueFactory |
Dient zum Abrufen oder Festlegen der Stellvertretung, die aufgerufen werden soll, um den Standardwert zu erstellen. |
| Description |
Ruft die Beschreibung des Symbols ab oder legt diese fest. (Geerbt von Symbol) |
| HasDefaultValue |
Gibt an, ob für die Option ein Standardwert definiert ist. (Geerbt von Option) |
| HelpName |
Dient zum Abrufen oder Festlegen des Platzhalternamens, der in der Verwendungshilfe für den Wert der Option angezeigt wird.
Der Wert wird in winkelige Klammern ( |
| Hidden |
Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Symbol ausgeblendet ist. (Geerbt von Symbol) |
| IsHidden |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| Name |
Ruft den Namen des Symbols ab. (Geerbt von Symbol) |
| Parents |
Ruft die übergeordneten Symbole ab. (Geerbt von Symbol) |
| RawAliases |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| Recursive |
Wenn diese Option auf "true" festgelegt ist, wird diese Option auf den unmittelbar übergeordneten Befehl oder die befehle angewendet und rekursiv auf ihre Unterbefehle angewendet. (Geerbt von Option) |
| Required |
Gibt an, ob die Option erforderlich ist, wenn der übergeordnete Befehl aufgerufen wird. (Geerbt von Option) |
| Validators |
Validatoren, die aufgerufen werden, wenn die Option vom Parser abgeglichen wird. (Geerbt von Option) |
| ValueType |
Ruft ab Type , in die die analysierten Token der Option konvertiert werden. |
Methoden
| Name | Beschreibung |
|---|---|
| AcceptLegalFileNamesOnly() |
Konfiguriert die Option, nur Werte zu akzeptieren, die rechtliche Dateinamen darstellen. |
| AcceptLegalFilePathsOnly() |
Konfiguriert die Option, nur Werte zu akzeptieren, die legale Dateipfade darstellen. |
| AcceptOnlyFromAmong(String[]) |
Konfiguriert die Option, nur die angegebenen Werte zu akzeptieren und sie als Befehlszeilenabschluss vorzuschlagen. |
| AcceptOnlyFromAmong(StringComparer, String[]) |
Konfiguriert die Option, nur die angegebenen Werte mithilfe des angegebenen Vergleichs zu akzeptieren und als Befehlszeilenabschluss vorzuschlagen. |
| AddAlias(String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| AddAliasInner(String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| AddValidator(ValidateSymbol<OptionResult>) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| ClearAliases() |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| GetCompletions(CompletionContext) |
Ruft Fertigstellungen für das Symbol ab. (Geerbt von Option) |
| GetDefaultValue() |
Ruft den Standardwert für die Option ab. (Geerbt von Option) |
| HasAlias(String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| HasRawAlias(String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| Suggest(String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol) |
Explizite Schnittstellenimplementierungen
| Name | Beschreibung |
|---|---|
| IOption.Argument |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| ISymbol.Children |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Symbol) |
| IValueDescriptor.GetDefaultValue() |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| IValueDescriptor.HasDefaultValue |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| IValueDescriptor.Type |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
| IValueDescriptor.ValueName |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. (Geerbt von Option) |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| AcceptExistingOnly<T>(Option<T>) |
Konfiguriert eine Option, um nur Werte zu akzeptieren, die vorhandenen Dateien oder Verzeichnissen entsprechen. |
| BuildAlias(IValueDescriptor) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. |
| Parse(Option, String) |
Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert. |
