Option Klasse

Definition

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert.

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

Vererbung

Object

Symbol

IdentifierSymbol

Option

Abgeleitet

System.CommandLine.Option<T>

Implementiert

IValueDescriptor

Konstruktoren

Option(String, String, Type, Func<Object>, ArgumentArity)	Initialisiert eine neue Instanz der Option-Klasse.
Option(String[], String, Type, Func<Object>, ArgumentArity)	Initialisiert eine neue Instanz der Option-Klasse.

Eigenschaften

Aliases	Ruft den Satz von Zeichenfolgen ab, der in der Befehlszeile verwendet werden kann, um das Symbol anzugeben. (Geerbt von IdentifierSymbol)
AllowMultipleArgumentsPerToken	Ruft einen Wert ab, der angibt, ob mehrere Argumenttoken für jedes Optionsbezeichnertoken zulässig sind.
ArgumentHelpName	Ruft den Namen des Arguments ab, wenn es in der Hilfe angezeigt wird, oder legt den Namen fest.
Arity	Ruft die Arität der Option ab oder legt sie fest.
Description	Ruft die Beschreibung des Symbols ab oder legt sie fest. (Geerbt von Symbol)
IsHidden	Ruft einen Wert ab, der angibt, ob das Symbol ausgeblendet ist, oder legt den Wert fest. (Geerbt von Symbol)
IsRequired	Gibt an, ob die Option erforderlich ist, wenn ihr übergeordneter Befehl aufgerufen wird.
Name	Ruft den Symbolnamen ab oder legt diese fest.
Parents	Ruft die übergeordneten Symbole ab. (Geerbt von Symbol)
ValueType	Das Type , unter dem die Argumente der Option analysiert werden sollen.

Methoden

AddAlias(String)	Fügt einen Alias hinzu. (Geerbt von IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)	Fügt einen Validierungsator hinzu, der aufgerufen wird, wenn die Option vom Parser abgeglichen wird.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetCompletions()	Ruft Vervollständigungen für das Symbol ab. (Geerbt von Symbol)
GetCompletions(CompletionContext)	Ruft die vorgeschlagenen Werte für die Befehlszeilen-Vervollständigung ab.
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
HasAlias(String)	Bestimmt, ob der Alias bereits definiert wurde. (Geerbt von IdentifierSymbol)
HasAliasIgnoringPrefix(String)	Gibt an, ob ein bestimmter Alias für die Option vorhanden ist, unabhängig vom Präfix.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
SetDefaultValue(Object)	Legt den Standardwert für die Option fest.
SetDefaultValueFactory(Func<Object>)	Legt einen Delegat fest, der aufgerufen werden soll, wenn der Standardwert für die Option erforderlich ist.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol)

Explizite Schnittstellenimplementierungen

IValueDescriptor.GetDefaultValue()	Ruft den Standardwert ab, falls vorhanden.
IValueDescriptor.HasDefaultValue	Ruft einen Wert ab, der angibt, ob ein Standardwert vorhanden ist.
IValueDescriptor.ValueName	Ruft den Namen des Werts ab.

Erweiterungsmethoden

Parse(Option, String)	Analysiert einen Befehlszeilenzeichenfolgenwert mithilfe einer Option.
Parse(Option, String[])	Analysiert einen Befehlszeilenzeichenfolgenwert mithilfe einer Option.

Weitere Informationen

• IdentifierSymbol