HelpOption 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.
Ett standardalternativ som anger att kommandoradshjälp ska visas.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Arv
Konstruktorer
| Name | Description |
|---|---|
| HelpOption() |
När det läggs till i en Commandkonfigureras programmet för att visa hjälp när något av följande alternativ anges på kommandoraden: |
| HelpOption(String, String[]) |
När det läggs till i en Commandkonfigureras programmet så att det visar hjälp när det angivna namnet eller något av aliasen anges på kommandoraden. |
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. (Ä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) |
| 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 |
Ett standardalternativ som anger att kommandoradshjälp ska visas. |
Metoder
| Name | Description |
|---|---|
| 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) |
