Option Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Symbol definiujący nazwany parametr i wartość dla tego parametru.
public ref class Option abstract : System::CommandLine::Symbol
public ref class Option : System::CommandLine::Symbol, System::CommandLine::IOption
public abstract class Option : System.CommandLine.Symbol
public class Option : System.CommandLine.Symbol, System.CommandLine.IOption
type Option = class
inherit Symbol
type Option = class
inherit Symbol
interface IOption
interface ISymbol
interface ISuggestionSource
interface IValueDescriptor
Public MustInherit Class Option
Inherits Symbol
Public Class Option
Inherits Symbol
Implements IOption
- Dziedziczenie
- Pochodne
- Implementuje
Konstruktory
| Nazwisko | Opis |
|---|---|
| Option(String, String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| Option(String, String[]) |
Inicjuje nowe wystąpienie klasy Option. |
| Option(String[], String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
Właściwości
| Nazwisko | 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ę. |
| Aliases |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| AllowMultipleArgumentsPerToken |
Pobiera wartość wskazującą, czy wiele tokenów argumentów jest dozwolonych dla każdego tokenu identyfikatora opcji. |
| Argument |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| Arity |
Pobiera lub ustawia arity opcji. |
| Children |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| CompletionSources |
Pobiera listę źródeł uzupełniania dla opcji . |
| Description |
Pobiera lub ustawia opis symbolu. (Odziedziczone po Symbol) |
| HasDefaultValue |
Określa, czy dla opcji zdefiniowano wartość domyślną. |
| 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 ( |
| Hidden |
Pobiera lub ustawia wartość wskazującą, czy symbol jest ukryty. (Odziedziczone po Symbol) |
| IsHidden |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| Name |
Pobiera nazwę symbolu. (Odziedziczone po Symbol) |
| Parents |
Pobiera symbole nadrzędne. (Odziedziczone po Symbol) |
| RawAliases |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (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. |
| Required |
Wskazuje, czy opcja jest wymagana po wywołaniu polecenia nadrzędnego. |
| Validators |
Moduły sprawdzania poprawności, które będą wywoływane po dopasowaniu opcji przez analizator. |
| ValueType |
Pobiera, na Type który zostaną przekonwertowane tokeny przeanalizowane przez opcję. |
Metody
| Nazwisko | Opis |
|---|---|
| AddAlias(String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| AddAliasInner(String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| AddValidator(ValidateSymbol<OptionResult>) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| ClearAliases() |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| GetCompletions(CompletionContext) |
Pobiera uzupełnienia symbolu. |
| GetDefaultValue() |
Pobiera wartość domyślną dla opcji . |
| HasAlias(String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| HasRawAlias(String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| Suggest(String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Symbol) |
Jawne implementacje interfejsu
| Nazwisko | Opis |
|---|---|
| IOption.Argument |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| ISymbol.Children |
Symbol definiujący nazwany parametr i wartość dla tego parametru. (Odziedziczone po Symbol) |
| IValueDescriptor.GetDefaultValue() |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| IValueDescriptor.HasDefaultValue |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| IValueDescriptor.Type |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| IValueDescriptor.ValueName |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
Metody rozszerzania
| Nazwisko | Opis |
|---|---|
| BuildAlias(IValueDescriptor) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |
| Parse(Option, String) |
Symbol definiujący nazwany parametr i wartość dla tego parametru. |