RootCommand 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 den huvudsakliga åtgärd som programmet utför.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Arv
Kommentarer
Använd RootCommand-objektet utan underkommandon för program som utför en åtgärd. Lägg till underkommandon i roten för program som kräver åtgärder som identifieras av specifika strängar. Till exempel använder "dir" inga underkommandon. Se Command för program med flera åtgärder.
Konstruktorer
| Name | Description |
|---|---|
| RootCommand(String) |
Representerar den huvudsakliga åtgärd som programmet utför. |
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. (Ärvd från Command) |
| Aliases |
Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange kommandot. (Ärvd från Command) |
| Argument |
Föråldrad.
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| Arguments |
Hämtar alla argument för kommandot. (Ärvd från Command) |
| Children |
Hämtar de underordnade symbolerna. (Ärvd från Command) |
| Description |
Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol) |
| Directives |
Representerar alla direktiv som är giltiga under rotkommandot. |
| ExecutableName |
Namnet på den körbara filen som körs. |
| ExecutablePath |
Sökvägen till den körbara filen som körs. |
| ExeName |
Representerar den huvudsakliga åtgärd som programmet utför. |
| ExePath |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Handler |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| HelpName |
Hämtar eller anger namnet som används för rotkommandot i hjälputdata. |
| Hidden |
Hämtar eller anger ett värde som anger om symbolen är dold. (Ärvd från Symbol) |
| IsHidden |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| Name |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Name |
Hämtar namnet på symbolen. (Ärvd från Symbol) |
| Options |
Hämtar alla alternativ för kommandot. (Ärvd från Command) |
| Parents |
Hämtar de överordnade symbolerna. (Ärvd från Symbol) |
| RawAliases |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| Subcommands |
Hämtar alla underkommandon för kommandot. (Ärvd från Command) |
| TreatUnmatchedTokensAsErrors |
Hämtar eller anger ett värde som anger om omatchade token ska behandlas som fel. (Ärvd från Command) |
| Validators |
Hämtar validatorerna till kommandot. Validatorer kan användas för att skapa anpassad valideringslogik. (Ärvd från Command) |
Metoder
| Name | Description |
|---|---|
| Add(Argument) |
Lägger till en Argument i kommandot. (Ärvd från Command) |
| Add(Command) |
Lägger till en Command i kommandot. (Ärvd från Command) |
| Add(Directive) |
Lägger till en Directive i kommandot. |
| Add(Option) |
Lägger till en Option i kommandot. (Ärvd från Command) |
| Add(Symbol) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| AddAlias(String) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| AddAliasInner(String) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| AddArgument(Argument) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| AddCommand(Command) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| AddOption(Option) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| ClearAliases() |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| GetCompletions(CompletionContext) |
Hämtar slutföranden för symbolen. (Ärvd från Command) |
| GetEnumerator() |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| HasAlias(String) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| HasRawAlias(String) |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Parsar en matrissträng med kommandot . (Ärvd från Command) |
| Parse(String, ParserConfiguration) |
Parsar ett kommandoradssträngvärde med kommandot . (Ärvd från Command) |
| SetAction(Action<ParseResult>) |
Anger en synkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Anger en asynkron åtgärd när kommandot anropas. (Ärvd från Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command) |
| SetAction(Func<ParseResult,Int32>) |
Anger en synkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command) |
| SetAction(Func<ParseResult,Task>) |
Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command) |
| Suggest(String) |
Representerar den huvudsakliga å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 den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| ICommand.Arguments |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| ICommand.Options |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Command) |
| IEnumerable.GetEnumerator() |
Returnerar en uppräknare som itererar genom en samling. (Ärvd från Command) |
| ISymbol.Children |
Representerar den huvudsakliga åtgärd som programmet utför. (Ärvd från Symbol) |
Tilläggsmetoder
| Name | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Invoke(Command, String, IConsole) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Invoke(Command, String[], IConsole) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| InvokeAsync(Command, String, IConsole) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| InvokeAsync(Command, String[], IConsole) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Representerar den huvudsakliga åtgärd som programmet utför. |
| Parse(Command, String[]) |
Representerar den huvudsakliga å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 den huvudsakliga åtgärd som programmet utför. |
