Option 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 symbool dat een benoemde parameter en een waarde voor die parameter definieert.
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
- Overname
- Afgeleid
- Implementeringen
Constructors
| Naam | Description |
|---|---|
| Option(String, String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| Option(String, String[]) |
Initialiseert een nieuw exemplaar van de Option klasse. |
| Option(String[], String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
Eigenschappen
| Naam | 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. |
| Aliases |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| AllowMultipleArgumentsPerToken |
Hiermee wordt een waarde opgehaald die aangeeft of meerdere argumenttokens zijn toegestaan voor elk optie-id-token. |
| Argument |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| Arity |
Hiermee haalt u de arity van de optie op of stelt u deze in. |
| Children |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| CompletionSources |
Hiermee haalt u de lijst met voltooiingsbronnen voor de optie op. |
| 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. |
| 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) |
| IsHidden |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (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) |
| RawAliases |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (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. |
| Required |
Geeft aan of de optie vereist is wanneer de bovenliggende opdracht wordt aangeroepen. |
| Validators |
Validators die worden aangeroepen wanneer de optie overeenkomt met de parser. |
| ValueType |
Hiermee wordt opgehaald Type waarnaar de geparseerde tokens van de optie worden geconverteerd. |
Methoden
| Naam | Description |
|---|---|
| AddAlias(String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| AddAliasInner(String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| AddValidator(ValidateSymbol<OptionResult>) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| ClearAliases() |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| GetCompletions(CompletionContext) |
Hiermee worden voltooiingen voor het symbool ophaalt. |
| GetDefaultValue() |
Hiermee wordt de standaardwaarde voor de optie opgehaald. |
| HasAlias(String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| HasRawAlias(String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| Suggest(String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| ToString() |
Retourneert een tekenreeks die het huidige object vertegenwoordigt. (Overgenomen van Symbol) |
Expliciete interface-implementaties
| Naam | Description |
|---|---|
| IOption.Argument |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| ISymbol.Children |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. (Overgenomen van Symbol) |
| IValueDescriptor.GetDefaultValue() |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| IValueDescriptor.HasDefaultValue |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| IValueDescriptor.Type |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| IValueDescriptor.ValueName |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
Extensiemethoden
| Naam | Description |
|---|---|
| BuildAlias(IValueDescriptor) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |
| Parse(Option, String) |
Een symbool dat een benoemde parameter en een waarde voor die parameter definieert. |