Option 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.
public ref class Option abstract : System::CommandLine::Symbolpublic abstract class Option : System.CommandLine.Symboltype Option = class
inherit SymbolPublic MustInherit Class Option
Inherits Symbol- Vererbung
- Abgeleitet
Konstruktoren
| Name | Beschreibung |
|---|---|
| Option(String, String[]) |
Initialisiert eine neue instance der Option -Klasse. |
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. |
| Aliases |
Ruft den eindeutigen Satz von Zeichenfolgen ab, die in der Befehlszeile verwendet werden können, um die Option anzugeben. |
| AllowMultipleArgumentsPerToken |
Ruft einen Wert ab, der angibt, ob mehrere Argumenttoken für jedes Optionsbezeichnertoken zulässig sind. |
| Arity |
Ruft ab oder legt die Arität der Option fest. |
| CompletionSources |
Ruft die Liste der Abschlussquellen für die Option ab. |
| 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. |
| 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) |
| Name |
Ruft den Namen des Symbols ab. (Geerbt von Symbol) |
| Parents |
Ruft die übergeordneten Symbole ab. (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. |
| Required |
Gibt an, ob die Option erforderlich ist, wenn der übergeordnete Befehl aufgerufen wird. |
| Validators |
Validatoren, die aufgerufen werden, wenn die Option vom Parser abgeglichen wird. |
| ValueType |
Ruft ab Type , in die die analysierten Token der Option konvertiert werden. |
Methoden
| Name | Beschreibung |
|---|---|
| GetCompletions(CompletionContext) |
Ruft Fertigstellungen für das Symbol ab. |
| GetDefaultValue() |
Ruft den Standardwert für die Option ab. |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol) |
