HelpOption Klas
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Een standaardoptie die aangeeft dat opdrachtregelhulp moet worden weergegeven.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Overname
Constructors
| Name | Description |
|---|---|
| HelpOption() |
Wanneer deze wordt toegevoegd aan een Commandtoepassing, wordt de toepassing geconfigureerd om hulp weer te geven wanneer een van de volgende opties is opgegeven op de opdrachtregel: |
| HelpOption(String, String[]) |
Wanneer deze wordt toegevoegd aan een Command, wordt de toepassing geconfigureerd om hulp weer te geven wanneer een bepaalde naam of een van de aliassen is opgegeven op de opdrachtregel. |
Eigenschappen
| Name | Description |
|---|---|
| Action |
Hiermee haalt u de optie op of stelt u deze CommandLineAction in. De handler vertegenwoordigt de actie die wordt uitgevoerd wanneer de optie wordt aangeroepen. |
| Aliases |
Hiermee haalt u de unieke set tekenreeksen op die op de opdrachtregel kunnen worden gebruikt om de optie op te geven. (Overgenomen van Option) |
| AllowMultipleArgumentsPerToken |
Hiermee wordt een waarde opgehaald die aangeeft of meerdere argumenttokens zijn toegestaan voor elk optie-id-token. (Overgenomen van Option) |
| Arity |
Hiermee haalt u de arity van de optie op of stelt u deze in. (Overgenomen van Option) |
| CompletionSources |
Hiermee haalt u de lijst met voltooiingsbronnen voor de optie op. (Overgenomen van Option) |
| Description |
Hiermee haalt u de beschrijving van het symbool op of stelt u deze in. (Overgenomen van Symbol) |
| HasDefaultValue |
Hiermee geeft u op of er een standaardwaarde is gedefinieerd voor de optie. (Overgenomen van Option) |
| HelpName |
Hiermee wordt de tijdelijke aanduidingsnaam opgehaald of ingesteld die wordt weergegeven in de help bij gebruik voor de waarde van de optie.
De waarde wordt verpakt tussen punthaken ( |
| Hidden |
Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of het symbool verborgen is. (Overgenomen van Symbol) |
| Name |
Hiermee haalt u de naam van het symbool op. (Overgenomen van Symbol) |
| Parents |
Haalt de bovenliggende symbolen op. (Overgenomen van Symbol) |
| Recursive |
Als deze optie is ingesteld op true, wordt deze optie toegepast op de directe bovenliggende opdracht of opdrachten en recursief op hun subopdrachten. (Overgenomen van Option) |
| Required |
Geeft aan of de optie vereist is wanneer de bovenliggende opdracht wordt aangeroepen. (Overgenomen van Option) |
| Validators |
Validators die worden aangeroepen wanneer de optie overeenkomt met de parser. (Overgenomen van Option) |
| ValueType |
Een standaardoptie die aangeeft dat opdrachtregelhulp moet worden weergegeven. |
Methoden
| Name | Description |
|---|---|
| GetCompletions(CompletionContext) |
Hiermee worden voltooiingen voor het symbool ophaalt. (Overgenomen van Option) |
| GetDefaultValue() |
Hiermee wordt de standaardwaarde voor de optie opgehaald. (Overgenomen van Option) |
| ToString() |
Retourneert een tekenreeks die het huidige object vertegenwoordigt. (Overgenomen van Symbol) |
