HelpOption Třída

Definice

Obor názvů:

System.CommandLine.Help

Sestavení:

System.CommandLine.dll

Balíček:

System.CommandLine v3.0.0-preview.7.26381.103

Zdroj:

HelpOption.cs

Standardní možnost označující, že by se měla zobrazit nápověda k příkazovému řádku.

public ref class HelpOption sealed : System::CommandLine::Option

public sealed class HelpOption : System.CommandLine.Option

type HelpOption = class
    inherit Option

Public NotInheritable Class HelpOption
Inherits Option

Dědičnost

Object

Symbol

Option

HelpOption

Konstruktory

Name	Description
HelpOption()	Při přidání do Commandaplikace nakonfiguruje, aby zobrazovala nápovědu v případě, že je na příkazovém řádku zadána jedna z následujících možností: -h /h --help -? /?
HelpOption(String, String[])	Při přidání do objektu Commandnakonfiguruje aplikaci tak, aby zobrazovala nápovědu v případě, že je zadaný název nebo jeden z aliasů, které jsou zadány na příkazovém řádku.

Vlastnosti

Name	Description
Action	Získá nebo nastaví CommandLineAction pro možnost. Obslužná rutina představuje akci, která se provede při vyvolání možnosti.
Aliases	Získá jedinečnou sadu řetězců, které lze použít na příkazovém řádku k určení Možnosti. (Zděděno od Option)
AllowMultipleArgumentsPerToken	Získá hodnotu, která určuje, zda je pro každý token identifikátoru možnosti povoleno více tokenů argumentů. (Zděděno od Option)
Arity	Získá nebo nastaví arity možnosti. (Zděděno od Option)
CompletionSources	Získá seznam zdrojů dokončení pro možnost. (Zděděno od Option)
Description	Získá nebo nastaví popis symbolu. (Zděděno od Symbol)
HasDefaultValue	Určuje, jestli je pro tuto možnost definována výchozí hodnota. (Zděděno od Option)
HelpName	Získá nebo nastaví zástupný název zobrazený v nápovědě k použití pro hodnotu možnosti. Hodnota bude zabalena do úhlových závorek (< a >). (Zděděno od Option)
Hidden	Získá nebo nastaví hodnotu označující, zda je symbol skrytý. (Zděděno od Symbol)
Name	Získá název symbolu. (Zděděno od Symbol)
Parents	Získá nadřazené symboly. (Zděděno od Symbol)
Recursive	Pokud je tato možnost nastavena na hodnotu true, použije se na jeho okamžitý nadřazený příkaz nebo příkazy a rekurzivně na jejich dílčí příkazy. (Zděděno od Option)
Required	Určuje, zda je při vyvolání nadřazeného příkazu požadována možnost. (Zděděno od Option)
Validators	Validátory, které budou volány při porovnávání možnosti analyzátorem. (Zděděno od Option)
ValueType	Standardní možnost označující, že by se měla zobrazit nápověda k příkazovému řádku.

Metody

Name	Description
GetCompletions(CompletionContext)	Získá dokončování symbolu. (Zděděno od Option)
GetDefaultValue()	Získá výchozí hodnotu pro možnost. (Zděděno od Option)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Symbol)