Sprache

Argument 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:
Argument.cs
Quelle:
Argument.cs
Quelle:
Argument.cs

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

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

Konstruktoren

Name Beschreibung
Argument()

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
Argument(String)

Initialisiert eine neue Instanz der Argument-Klasse.

Eigenschaften

Name Beschreibung
Aliases

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
ArgumentType

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
Arity

Ruft ab oder legt die Arität des Arguments fest.
CaptureRemainingTokens

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieses Argument alle verbleibenden Token erfasst.
Children

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
CompletionSources

Ruft die Liste der Abschlussquellen für das Argument ab.
Description

Ruft die Beschreibung des Symbols ab oder legt diese fest.

(Geerbt von Symbol)
HasDefaultValue

Gibt an, ob für das Argument ein Standardwert definiert ist.
HelpName

Dient zum Abrufen oder Festlegen des Platzhalternamens, der in der Verwendungshilfe für den Wert des Arguments 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 Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(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 Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
Validators

Stellt eine Liste der Argumentprüfer bereit. Validatoren können verwendet werden, um benutzerdefinierte Fehler basierend auf der Benutzereingabe bereitzustellen.
ValueType

Ruft ab oder legt fest Type , in dass die analysierten Token des Arguments in konvertiert werden.

Methoden

Name Beschreibung
AddAliasInner(String)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
AddSuggestions(IReadOnlyCollection<String>)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
AddSuggestionSource(ISuggestionSource)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
AddSuggestionSource(Suggest)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
AddValidator(ValidateSymbol<ArgumentResult>)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
ClearAliases()

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
GetCompletions(CompletionContext)

Ruft Fertigstellungen für das Symbol ab.
GetDefaultValue()

Ruft den Standardwert für das Argument ab.
HasAlias(String)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
HasRawAlias(String)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
SetDefaultValue(Func<Object>)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
SetDefaultValue(Object)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
Suggest(String)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

Explizite Schnittstellenimplementierungen

Name Beschreibung
IArgument.Arity

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
ISymbol.Children

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

(Geerbt von Symbol)
IValueDescriptor.Type

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.
IValueDescriptor.ValueName

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

Erweiterungsmethoden

Name Beschreibung
BuildAlias(IValueDescriptor)

Ein Symbol, das einen Wert definiert, der an einen Befehl oder eine Option an die Befehlszeile übergeben werden kann.

Gilt für: