Argument<T> Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ.
generic <typename T>
public ref class Argument : System::CommandLine::Argument
public class Argument<T> : System.CommandLine.Argument
type Argument<'T> = class
inherit Argument
Public Class Argument(Of T)
Inherits Argument
Typparametrar
- T
- Arv
Konstruktorer
| Name | Description |
|---|---|
| Argument<T>() |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. |
| Argument<T>(Func<T>) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. |
| Argument<T>(String, T) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. |
| Argument<T>(String) |
Initierar en ny instans av klassen Argument. |
| Argument<T>(TryConvertArgument<T>) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. |
Egenskaper
| Name | Description |
|---|---|
| Aliases |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| ArgumentType |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| Arity |
Hämtar eller anger argumentets aritet. (Ärvd från Argument) |
| CaptureRemainingTokens |
Hämtar eller anger ett värde som anger om det här argumentet samlar in alla återstående token. (Ärvd från Argument) |
| Children |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| CompletionSources |
Hämtar listan över slutförandekällor för argumentet. (Ärvd från Argument) |
| CustomParser |
Hämtar eller anger en anpassad argumentparser. |
| DefaultValueFactory |
Hämtar eller anger ombudet som ska anropas för att skapa standardvärdet. |
| Description |
Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol) |
| HasDefaultValue |
Anger om ett standardvärde har definierats för argumentet. |
| HasDefaultValue |
Anger om ett standardvärde har definierats för argumentet. (Ärvd från Argument) |
| HelpName |
Hämtar eller anger platshållarnamnet som visas i användningshjälpen för argumentets värde.
Värdet kommer att omslutas i vinkelparenteser ( |
| Hidden |
Hämtar eller anger ett värde som anger om symbolen är dold. (Ärvd från Symbol) |
| IsHidden |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| Name |
Hämtar namnet på symbolen. (Ärvd från Symbol) |
| Parents |
Hämtar de överordnade symbolerna. (Ärvd från Symbol) |
| RawAliases |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| Validators |
Innehåller en lista över argumentverifierare. Validatorer kan användas för att tillhandahålla anpassade fel baserat på användarindata. (Ärvd från Argument) |
| ValueType |
Hämtar eller anger Type att argumentets parsade token ska konverteras till. |
Metoder
| Name | Description |
|---|---|
| AddAliasInner(String) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| AddSuggestions(IReadOnlyCollection<String>) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| AddSuggestionSource(ISuggestionSource) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| AddSuggestionSource(Suggest) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| AddValidator(ValidateSymbol<ArgumentResult>) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| ClearAliases() |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| GetCompletions(CompletionContext) |
Hämtar slutföranden för symbolen. (Ärvd från Argument) |
| GetDefaultValue() |
Hämtar standardvärdet för argumentet. (Ärvd från Argument) |
| HasAlias(String) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| HasRawAlias(String) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| SetDefaultValue(Func<Object>) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| SetDefaultValue(Object) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| Suggest(String) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| ToString() |
Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Argument) |
Explicita gränssnittsimplementeringar
| Name | Description |
|---|---|
| IArgument.Arity |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| ISymbol.Children |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Symbol) |
| IValueDescriptor.Type |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
| IValueDescriptor.ValueName |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. (Ärvd från Argument) |
Tilläggsmetoder
| Name | Description |
|---|---|
| AcceptExistingOnly<T>(Argument<T>) |
Konfigurerar ett argument för att endast acceptera värden som motsvarar en befintlig fil eller katalog. |
| AcceptLegalFileNamesOnly<T>(Argument<T>) |
Konfigurerar argumentet för att endast acceptera värden som representerar juridiska filnamn. |
| AcceptLegalFilePathsOnly<T>(Argument<T>) |
Konfigurerar argumentet för att endast acceptera värden som representerar juridiska filsökvägar. |
| AcceptOnlyFromAmong<T>(Argument<T>, String[]) |
Konfigurerar argumentet för att endast acceptera de angivna värdena och föreslå dem som slutförda kommandorader. |
| AcceptOnlyFromAmong<T>(Argument<T>, StringComparer, String[]) |
Konfigurerar argumentet att endast acceptera de angivna värdena med den angivna jämförelsen och att föreslå dem som slutförda kommandorader. |
| BuildAlias(IValueDescriptor) |
En symbol som definierar ett värde som kan skickas på kommandoraden till ett kommando eller alternativ. |