Option Klass

Definition

Namnområde:
System.CommandLine
Sammansättning:
System.CommandLine.dll
Paket:
System.CommandLine v3.0.0-preview.4.26230.115
Källa:
Option.cs
Källa:
Option.cs
Källa:
Option.cs

En symbol som definierar en namngiven parameter och ett värde för den parametern.

public ref class Option abstract : System::CommandLine::Symbol
public abstract class Option : System.CommandLine.Symbol
type Option = class
    inherit Symbol
Public MustInherit Class Option
Inherits Symbol
Arv
Object
Symbol
Option
Härledda

Konstruktorer

Name Description
Option(String, String[])

Initierar en ny instans av Option klassen.

Egenskaper

Name Description
Action

Hämtar eller anger CommandLineAction för alternativet. Hanteraren representerar den åtgärd som ska utföras när alternativet anropas.
Aliases

Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange alternativet.
AllowMultipleArgumentsPerToken

Hämtar ett värde som anger om flera argumenttoken tillåts för varje alternatividentifierartoken.
Arity

Hämtar eller anger alternativets aritet.
CompletionSources

Hämtar listan över slutförandekällor för alternativet.
Description

Hämtar eller anger beskrivningen av symbolen.

(Ärvd från Symbol)
HasDefaultValue

Anger om ett standardvärde har definierats för alternativet.
HelpName

Hämtar eller anger platshållarnamnet som visas i användningshjälpen för alternativets värde. Värdet kommer att omslutas i vinkelparenteser (< och >).
Hidden

Hämtar eller anger ett värde som anger om symbolen är dold.

(Ärvd från Symbol)
Name

Hämtar namnet på symbolen.

(Ärvd från Symbol)
Parents

Hämtar de överordnade symbolerna.

(Ärvd från Symbol)
Recursive

När värdet är true tillämpas det här alternativet på dess omedelbara överordnade kommando eller kommandon och rekursivt på deras underkommandon.
Required

Anger om alternativet krävs när dess överordnade kommando anropas.
Validators

Validatorer som anropas när alternativet matchas av parsern.
ValueType

Hämtar det Type som alternativets parsade token konverteras till.

Metoder

Name Description
GetCompletions(CompletionContext)

Hämtar slutföranden för symbolen.
GetDefaultValue()

Hämtar standardvärdet för alternativet.
ToString()

Returnerar en sträng som representerar det aktuella objektet.

(Ärvd från Symbol)

Gäller för