Option<T> Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
En symbol som definierar en namngiven parameter och ett värde för den parametern.
generic <typename T>
public ref class Option : System::CommandLine::Optionpublic class Option<T> : System.CommandLine.Optiontype Option<'T> = class
inherit OptionPublic Class Option(Of T)
Inherits OptionTypparametrar
- T
Att Type alternativets argument förväntas parsas som.
- Arv
Konstruktorer
| Name | Description |
|---|---|
| Option<T>(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. (Ärvd från Option) |
| Aliases |
Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange alternativet. (Ärvd från Option) |
| AllowMultipleArgumentsPerToken |
Hämtar ett värde som anger om flera argumenttoken tillåts för varje alternatividentifierartoken. (Ärvd från Option) |
| Arity |
Hämtar eller anger alternativets aritet. (Ärvd från Option) |
| CompletionSources |
Hämtar listan över slutförandekällor för alternativet. (Ärvd från Option) |
| CustomParser |
Hämtar eller anger en anpassad argumentparser. |
| DefaultValueFactory |
Hämtar eller anger ombudet som ska anropas för att skapa standardvärdet. |
| Description |
Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol) |
| HasDefaultValue |
Anger om ett standardvärde har definierats för alternativet. (Ärvd från Option) |
| 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 ( |
| 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. (Ärvd från Option) |
| Required |
Anger om alternativet krävs när dess överordnade kommando anropas. (Ärvd från Option) |
| Validators |
Validatorer som anropas när alternativet matchas av parsern. (Ärvd från Option) |
| ValueType |
Hämtar det Type som alternativets parsade token konverteras till. |
Metoder
| Name | Description |
|---|---|
| AcceptLegalFileNamesOnly() |
Konfigurerar alternativet att endast acceptera värden som representerar juridiska filnamn. |
| AcceptLegalFilePathsOnly() |
Konfigurerar alternativet att endast acceptera värden som representerar juridiska filsökvägar. |
| AcceptOnlyFromAmong(String[]) |
Konfigurerar alternativet att endast acceptera de angivna värdena och att föreslå dem som slutförda kommandorader. |
| AcceptOnlyFromAmong(StringComparer, String[]) |
Konfigurerar alternativet att endast acceptera de angivna värdena med den angivna jämförelsen och att föreslå dem som slutförda kommandorader. |
| GetCompletions(CompletionContext) |
Hämtar slutföranden för symbolen. (Ärvd från Option) |
| GetDefaultValue() |
Hämtar standardvärdet för alternativet. (Ärvd från Option) |
| ToString() |
Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Symbol) |
Tilläggsmetoder
| Name | Description |
|---|---|
| AcceptExistingOnly<T>(Option<T>) |
Konfigurerar ett alternativ för att endast acceptera värden som motsvarar befintliga filer eller kataloger. |
