RootCommand 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.
Reprezentuje akcję główną wykonywaną przez aplikację.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Dziedziczenie
Uwagi
Użyj obiektu RootCommand bez żadnych poleceń podrzędnych dla aplikacji, które wykonują jedną akcję. Dodaj podpolecenia do katalogu głównego dla aplikacji, które wymagają akcji zidentyfikowanych przez określone ciągi. Na przykład "dir" nie używa żadnych podpolecenia. Zobacz Command aplikacje z wieloma akcjami.
Konstruktory
| Nazwisko | Opis |
|---|---|
| RootCommand(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
Właściwości
| Nazwisko | Opis |
|---|---|
| Action |
Pobiera lub ustawia CommandLineAction wartość dla polecenia . Procedura obsługi reprezentuje akcję, która zostanie wykonana po wywołaniu polecenia. (Odziedziczone po Command) |
| Aliases |
Pobiera unikatowy zestaw ciągów, których można użyć w wierszu polecenia, aby określić polecenie. (Odziedziczone po Command) |
| Argument |
Przestarzałe.
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| Arguments |
Pobiera wszystkie argumenty dla polecenia . (Odziedziczone po Command) |
| Children |
Pobiera symbole podrzędne. (Odziedziczone po Command) |
| Description |
Pobiera lub ustawia opis symbolu. (Odziedziczone po Symbol) |
| Directives |
Reprezentuje wszystkie dyrektywy, które są prawidłowe w poleceniu głównym. |
| ExecutableName |
Nazwa aktualnie uruchomionego pliku wykonywalnego. |
| ExecutablePath |
Ścieżka do aktualnie uruchomionego pliku wykonywalnego. |
| ExeName |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| ExePath |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Handler |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| HelpName |
Pobiera lub ustawia nazwę używaną dla głównego polecenia w danych wyjściowych pomocy. |
| Hidden |
Pobiera lub ustawia wartość wskazującą, czy symbol jest ukryty. (Odziedziczone po Symbol) |
| IsHidden |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| Name |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Name |
Pobiera nazwę symbolu. (Odziedziczone po Symbol) |
| Options |
Pobiera wszystkie opcje polecenia. (Odziedziczone po Command) |
| Parents |
Pobiera symbole nadrzędne. (Odziedziczone po Symbol) |
| RawAliases |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| Subcommands |
Pobiera wszystkie polecenia podrzędne dla polecenia . (Odziedziczone po Command) |
| TreatUnmatchedTokensAsErrors |
Pobiera lub ustawia wartość wskazującą, czy niedopasowane tokeny powinny być traktowane jako błędy. (Odziedziczone po Command) |
| Validators |
Pobiera moduły sprawdzania poprawności do polecenia. Moduły sprawdzania poprawności mogą służyć do tworzenia niestandardowej logiki walidacji. (Odziedziczone po Command) |
Metody
| Nazwisko | Opis |
|---|---|
| Add(Argument) |
Dodaje element Argument do polecenia . (Odziedziczone po Command) |
| Add(Command) |
Dodaje element Command do polecenia . (Odziedziczone po Command) |
| Add(Directive) |
Dodaje element Directive do polecenia . |
| Add(Option) |
Dodaje element Option do polecenia . (Odziedziczone po Command) |
| Add(Symbol) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| AddAlias(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| AddAliasInner(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| AddArgument(Argument) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| AddCommand(Command) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| AddOption(Option) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| ClearAliases() |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| GetCompletions(CompletionContext) |
Pobiera uzupełnienia symbolu. (Odziedziczone po Command) |
| GetEnumerator() |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| HasAlias(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| HasRawAlias(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analizuje ciągi tablicowe przy użyciu polecenia . (Odziedziczone po Command) |
| Parse(String, ParserConfiguration) |
Analizuje wartość ciągu wiersza polecenia przy użyciu polecenia . (Odziedziczone po Command) |
| SetAction(Action<ParseResult>) |
Ustawia akcję synchroniczną do uruchomienia po wywołaniu polecenia. (Odziedziczone po Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Ustawia akcję asynchroniczną po wywołaniu polecenia. (Odziedziczone po Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Ustawia akcję asynchroniczną do uruchomienia po wywołaniu polecenia. (Odziedziczone po Command) |
| SetAction(Func<ParseResult,Int32>) |
Ustawia akcję synchroniczną do uruchomienia po wywołaniu polecenia. (Odziedziczone po Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Ustawia akcję asynchroniczną do uruchomienia po wywołaniu polecenia. (Odziedziczone po Command) |
| SetAction(Func<ParseResult,Task>) |
Ustawia akcję asynchroniczną do uruchomienia po wywołaniu polecenia. (Odziedziczone po Command) |
| Suggest(String) |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
| ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Symbol) |
Jawne implementacje interfejsu
| Nazwisko | Opis |
|---|---|
| ICommand.Argument |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| ICommand.Arguments |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| ICommand.Options |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Command) |
| IEnumerable.GetEnumerator() |
Zwraca moduł wyliczający, który iteruje za pośrednictwem kolekcji. (Odziedziczone po Command) |
| ISymbol.Children |
Reprezentuje akcję główną wykonywaną przez aplikację. (Odziedziczone po Symbol) |
Metody rozszerzania
| Nazwisko | Opis |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| FunctionName(Command, String[]) |
Utwórz unikatową nazwę funkcji powłoki dla polecenia — te nazwy powinny być następujące:
|
| HierarchicalOptions(Command) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Invoke(Command, String, IConsole) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Invoke(Command, String[], IConsole) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| InvokeAsync(Command, String, IConsole) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| InvokeAsync(Command, String[], IConsole) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Names(Command) |
Pobierz wszystkie nazwy polecenia, w tym nazwę podstawową i wszystkie aliasy |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| Parse(Command, String[]) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Konwertuje IEnumerable<T> na IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Tworzy FrozenDictionary<TKey,TValue> z IEnumerable<T> zgodnie z określonymi funkcjami selektora kluczy i selektora elementów. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Tworzy element FrozenDictionary<TKey,TValue> na podstawie IEnumerable<T> określonej funkcji selektora kluczy. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Tworzy obiekt FrozenSet<T> z określonymi wartościami. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Tworzy niezmienną tablicę z określonej kolekcji. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Wylicza i przekształca sekwencję oraz tworzy niezmienny słownik jego zawartości przy użyciu określonych porównań kluczy i wartości. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Wylicza i przekształca sekwencję i tworzy niezmienny słownik jego zawartości przy użyciu określonego porównania kluczy. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Wylicza i przekształca sekwencję oraz tworzy niezmienny słownik jego zawartości. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Tworzy niezmienny słownik na podstawie niektórych przekształceń sekwencji. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Tworzy niezmienny słownik z istniejącej kolekcji elementów, stosując funkcję przekształcania do kluczy źródłowych. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Wylicza sekwencję, tworzy niezmienny zestaw skrótów jego zawartości i używa określonego porównania równości dla typu zestawu. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Wylicza sekwencję i tworzy niezmienny zestaw skrótów jego zawartości. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Wylicza sekwencję i tworzy niezmienną listę jego zawartości. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Wylicza i przekształca sekwencję oraz tworzy niezmienny posortowany słownik jego zawartości przy użyciu określonych porównań kluczy i wartości. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Wylicza i przekształca sekwencję i tworzy niezmienny posortowany słownik jego zawartości przy użyciu określonego porównania kluczy. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Wylicza i przekształca sekwencję i tworzy niezmienny posortowany słownik jego zawartości. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Wylicza sekwencję, tworzy niezmienialny zestaw posortowany jego zawartości i używa określonego porównania. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Wylicza sekwencję i tworzy niezmienny posortowany zestaw jego zawartości. |
| UseCommandHandler<THandler>(Command) |
Reprezentuje akcję główną wykonywaną przez aplikację. |
