Command 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.
Representerar en specifik åtgärd som programmet utför.
public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable
public ref class Command : System::CommandLine::Symbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>, System::CommandLine::ICommand
public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
public class Command : System.CommandLine.Symbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>, System.CommandLine.ICommand
type Command = class
inherit Symbol
interface IEnumerable
type Command = class
inherit Symbol
interface ICommand
interface ISymbol
interface ISuggestionSource
interface seq<Symbol>
interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
Public Class Command
Inherits Symbol
Implements ICommand, IEnumerable(Of Symbol)
- Arv
- Härledda
- Implementeringar
Kommentarer
Använd kommandoobjektet för åtgärder som motsvarar en specifik sträng (kommandonamnet). Information om enkla program som bara har en åtgärd finns i RootCommand. Använder till exempel dotnet runrun som kommando.
Konstruktorer
| Name | Description |
|---|---|
| Command(String, String) |
Initierar en ny instans av klassen Command. |
Egenskaper
| Name | Description |
|---|---|
| Action |
Hämtar eller anger CommandLineAction för kommandot. Hanteraren representerar den åtgärd som ska utföras när kommandot anropas. |
| Aliases |
Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange kommandot. |
| Aliases |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| Argument |
Föråldrad.
Representerar en specifik åtgärd som programmet utför. |
| Arguments |
Hämtar alla argument för kommandot. |
| Children |
Hämtar de underordnade symbolerna. |
| Children |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| Description |
Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol) |
| Handler |
Representerar en specifik åtgärd som programmet utför. |
| Hidden |
Hämtar eller anger ett värde som anger om symbolen är dold. (Ärvd från Symbol) |
| IsHidden |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| Name |
Hämtar namnet på symbolen. (Ärvd från Symbol) |
| Options |
Hämtar alla alternativ för kommandot. |
| Parents |
Hämtar de överordnade symbolerna. (Ärvd från Symbol) |
| RawAliases |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| Subcommands |
Hämtar alla underkommandon för kommandot. |
| TreatUnmatchedTokensAsErrors |
Hämtar eller anger ett värde som anger om omatchade token ska behandlas som fel. |
| Validators |
Hämtar validatorerna till kommandot. Validatorer kan användas för att skapa anpassad valideringslogik. |
Metoder
| Name | Description |
|---|---|
| Add(Argument) |
Lägger till en Argument i kommandot. |
| Add(Command) |
Lägger till en Command i kommandot. |
| Add(Option) |
Lägger till en Option i kommandot. |
| Add(Symbol) |
Representerar en specifik åtgärd som programmet utför. |
| AddAlias(String) |
Representerar en specifik åtgärd som programmet utför. |
| AddAliasInner(String) |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| AddArgument(Argument) |
Representerar en specifik åtgärd som programmet utför. |
| AddCommand(Command) |
Representerar en specifik åtgärd som programmet utför. |
| AddOption(Option) |
Representerar en specifik åtgärd som programmet utför. |
| AddValidator(ValidateSymbol<CommandResult>) |
Representerar en specifik åtgärd som programmet utför. |
| ClearAliases() |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| GetCompletions(CompletionContext) |
Hämtar slutföranden för symbolen. |
| GetEnumerator() |
Representerar en specifik åtgärd som programmet utför. |
| HasAlias(String) |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| HasRawAlias(String) |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Parsar en matrissträng med kommandot . |
| Parse(String, ParserConfiguration) |
Parsar ett kommandoradssträngvärde med kommandot . |
| SetAction(Action<ParseResult>) |
Anger en synkron åtgärd som ska köras när kommandot anropas. |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Anger en asynkron åtgärd när kommandot anropas. |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. |
| SetAction(Func<ParseResult,Int32>) |
Anger en synkron åtgärd som ska köras när kommandot anropas. |
| SetAction(Func<ParseResult,Task<Int32>>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. |
| SetAction(Func<ParseResult,Task>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. |
| Suggest(String) |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
| ToString() |
Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Symbol) |
Explicita gränssnittsimplementeringar
| Name | Description |
|---|---|
| ICommand.Argument |
Representerar en specifik åtgärd som programmet utför. |
| ICommand.Arguments |
Representerar en specifik åtgärd som programmet utför. |
| ICommand.Options |
Representerar en specifik åtgärd som programmet utför. |
| IEnumerable.GetEnumerator() |
Returnerar en uppräknare som itererar genom en samling. |
| ISymbol.Children |
Representerar en specifik åtgärd som programmet utför. (Ärvd från Symbol) |
Tilläggsmetoder
| Name | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Representerar en specifik åtgärd som programmet utför. |
| Invoke(Command, String, IConsole) |
Representerar en specifik åtgärd som programmet utför. |
| Invoke(Command, String[], IConsole) |
Representerar en specifik åtgärd som programmet utför. |
| InvokeAsync(Command, String, IConsole) |
Representerar en specifik åtgärd som programmet utför. |
| InvokeAsync(Command, String[], IConsole) |
Representerar en specifik åtgärd som programmet utför. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Representerar en specifik åtgärd som programmet utför. |
| Parse(Command, String[]) |
Representerar en specifik åtgärd som programmet utför. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Konverterar en IEnumerable<T> till en IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Skapar en FrozenDictionary<TKey,TValue> från en IEnumerable<T> enligt angivna funktioner för nyckelväljare och elementväljare. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Skapar en FrozenDictionary<TKey,TValue> från en IEnumerable<T> enligt angiven nyckelväljare. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Skapar en FrozenSet<T> med de angivna värdena. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Skapar en oföränderlig matris från den angivna samlingen. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig ordlista med dess innehåll med hjälp av de angivna nyckel- och värdejäxorna. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig ordlista med dess innehåll med hjälp av den angivna nyckeljäxaren. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig ordlista med dess innehåll. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Konstruerar en oföränderlig ordlista baserat på en viss omvandling av en sekvens. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Konstruerar en oföränderlig ordlista från en befintlig samling element och tillämpar en transformeringsfunktion på källnycklarna. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Räknar upp en sekvens, skapar en oföränderlig hashuppsättning av innehållet och använder den angivna likhetsjämföraren för den angivna typen. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Räknar upp en sekvens och skapar en oföränderlig hashuppsättning med dess innehåll. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Räknar upp en sekvens och skapar en oföränderlig lista över dess innehåll. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig sorterad ordlista med dess innehåll med hjälp av de angivna nyckel- och värdejäxorna. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig sorterad ordlista med dess innehåll med hjälp av den angivna nyckeljäxaren. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Räknar upp och transformerar en sekvens och skapar en oföränderlig sorterad ordlista med dess innehåll. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Räknar upp en sekvens, skapar en oföränderlig sorterad uppsättning av dess innehåll och använder den angivna jämförelsen. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Räknar upp en sekvens och skapar en oföränderlig sorterad uppsättning av dess innehåll. |
| UseCommandHandler<THandler>(Command) |
Representerar en specifik åtgärd som programmet utför. |