Sprache

Option Klasse

Definition

Namespace:
System.CommandLine
Assembly:
System.CommandLine.dll
Paket:
System.CommandLine v3.0.0-rc.1.26425.128
Paket:
System.CommandLine.Experimental v0.3.0-alpha.19577.1
Quelle:
Option.cs
Quelle:
Option.cs
Quelle:
Option.cs

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

public ref class Option abstract : System::CommandLine::Symbol
public ref class Option : System::CommandLine::Symbol, System::CommandLine::IOption
public abstract class Option : System.CommandLine.Symbol
public class Option : System.CommandLine.Symbol, System.CommandLine.IOption
type Option = class
    inherit Symbol
type Option = class
    inherit Symbol
    interface IOption
    interface ISymbol
    interface ISuggestionSource
    interface IValueDescriptor
Public MustInherit Class Option
Inherits Symbol
Public Class Option
Inherits Symbol
Implements IOption
Vererbung
Object
Symbol
Option
Abgeleitet
Implementiert
IValueDescriptor IOption ISuggestionSource ISymbol

Konstruktoren

Name Beschreibung
Option(String, String)

Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert.
Option(String, String[])

Initialisiert eine neue Instanz der Option-Klasse.
Option(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.
Aliases

Ruft den eindeutigen Satz von Zeichenfolgen ab, die in der Befehlszeile verwendet werden können, um die Option anzugeben.
Aliases

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

(Geerbt von Symbol)
AllowMultipleArgumentsPerToken

Ruft einen Wert ab, der angibt, ob mehrere Argumenttoken für jedes Optionsbezeichnertoken zulässig sind.
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.
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.
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 (< und >) eingeschlossen.
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.
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
AddAlias(String)

Ein Symbol, das einen benannten Parameter und einen Wert für diesen Parameter definiert.
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.
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.
GetDefaultValue()

Ruft den Standardwert für die Option ab.
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.
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.
IValueDescriptor.HasDefaultValue

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

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

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

Erweiterungsmethoden

Name Beschreibung
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.

Gilt für: