HelpOption Klasa

Definicja

Przestrzeń nazw:

System.CommandLine.Help

Zestaw:

System.CommandLine.dll

Pakiet:

System.CommandLine v3.0.0-preview.2.26159.112

Źródło:

HelpOption.cs

Standardowa opcja wskazująca, że powinna być wyświetlana pomoc wiersza polecenia.

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

Dziedziczenie

Object

Symbol

Option

HelpOption

Konstruktory

Nazwa	Opis
HelpOption()	Po dodaniu do elementu program konfiguruje aplikację Commandtak, aby wyświetlała pomoc, gdy w wierszu polecenia określono jedną z następujących opcji: -h /h --help -? /?
HelpOption(String, String[])	Po dodaniu do elementu program konfiguruje aplikację Commandtak, aby wyświetlała pomoc, gdy dana nazwa lub jeden z aliasów są określone w wierszu polecenia.

Właściwości

Nazwa	Opis
Action	Pobiera lub ustawia CommandLineAction wartość dla opcji. Procedura obsługi reprezentuje akcję, która zostanie wykonana po wywołaniu opcji.
Aliases	Pobiera unikatowy zestaw ciągów, których można użyć w wierszu polecenia, aby określić opcję. (Odziedziczone po Option)
AllowMultipleArgumentsPerToken	Pobiera wartość wskazującą, czy wiele tokenów argumentów jest dozwolonych dla każdego tokenu identyfikatora opcji. (Odziedziczone po Option)
Arity	Pobiera lub ustawia arity opcji. (Odziedziczone po Option)
CompletionSources	Pobiera listę źródeł uzupełniania dla opcji . (Odziedziczone po Option)
Description	Pobiera lub ustawia opis symbolu. (Odziedziczone po Symbol)
HasDefaultValue	Określa, czy dla opcji zdefiniowano wartość domyślną. (Odziedziczone po Option)
HelpName	Pobiera lub ustawia nazwę symbolu zastępczego wyświetlaną w pomocy użycia dla wartości opcji. Wartość zostanie opakowana w nawiasy kątowe (< i >). (Odziedziczone po Option)
Hidden	Pobiera lub ustawia wartość wskazującą, czy symbol jest ukryty. (Odziedziczone po Symbol)
Name	Pobiera nazwę symbolu. (Odziedziczone po Symbol)
Parents	Pobiera symbole nadrzędne. (Odziedziczone po Symbol)
Recursive	Po ustawieniu wartości true ta opcja zostanie zastosowana do jego natychmiastowego polecenia nadrzędnego lub poleceń i cyklicznie do ich podpolecenia. (Odziedziczone po Option)
Required	Wskazuje, czy opcja jest wymagana po wywołaniu polecenia nadrzędnego. (Odziedziczone po Option)
Validators	Moduły sprawdzania poprawności, które będą wywoływane po dopasowaniu opcji przez analizator. (Odziedziczone po Option)
ValueType	Standardowa opcja wskazująca, że powinna być wyświetlana pomoc wiersza polecenia.

Metody

Nazwa	Opis
GetCompletions(CompletionContext)	Pobiera uzupełnienia symbolu. (Odziedziczone po Option)
GetDefaultValue()	Pobiera wartość domyślną dla opcji . (Odziedziczone po Option)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Symbol)