RootCommand Klasa

Definicja

Przestrzeń nazw:

System.CommandLine

Zestaw:

System.CommandLine.dll

Reprezentuje akcję główną wykonywaną przez aplikację.

public ref class RootCommand : System::CommandLine::Command

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Dziedziczenie

Object

Symbol

IdentifierSymbol

Command

RootCommand

Uwagi

Użyj obiektu RootCommand bez żadnych podpolecenia dla aplikacji wykonujących jedną akcję. Dodaj podpolecenia do katalogu głównego aplikacji, które wymagają akcji zidentyfikowanych przez określone ciągi. Na przykład "dir" nie używa żadnych podpolecenia. Zobacz, aby zapoznać się Command z aplikacjami z wieloma akcjami.

Konstruktory

RootCommand(String)

Reprezentuje akcję główną wykonywaną przez aplikację.

Właściwości

Aliases	Pobiera zestaw ciągów, których można użyć w wierszu polecenia, aby określić symbol. (Odziedziczone po IdentifierSymbol)
Arguments	Reprezentuje wszystkie argumenty polecenia . (Odziedziczone po Command)
Children	Pobiera symbole podrzędne. (Odziedziczone po Command)
Description	Pobiera lub ustawia opis symbolu. (Odziedziczone po Symbol)
ExecutableName	Nazwa aktualnie uruchomionego pliku wykonywalnego.
ExecutablePath	Ścieżka do aktualnie uruchomionego pliku wykonywalnego.
Handler	Pobiera lub ustawia ICommandHandler dla polecenia . Procedura obsługi reprezentuje akcję, która zostanie wykonana po wywołaniu polecenia. (Odziedziczone po Command)
IsHidden	Pobiera lub ustawia wartość wskazującą, czy symbol jest ukryty. (Odziedziczone po Symbol)
Name	Pobiera lub ustawia nazwę symbolu. (Odziedziczone po IdentifierSymbol)
Options	Reprezentuje wszystkie opcje polecenia, w tym opcje globalne, które zostały zastosowane do dowolnego z elementów przodków polecenia. (Odziedziczone po Command)
Parents	Pobiera symbole nadrzędne. (Odziedziczone po Symbol)
Subcommands	Reprezentuje wszystkie podpolecenia polecenia. (Odziedziczone po Command)
TreatUnmatchedTokensAsErrors	Pobiera lub ustawia wartość wskazującą, czy niezapasowane tokeny powinny być traktowane jako błędy. Jeśli na przykład ustawiono wartość true i zostanie podane dodatkowe polecenie lub argument, walidacja zakończy się niepowodzeniem. (Odziedziczone po Command)

Metody

Add(Argument)	Dodaje element Argument do polecenia . (Odziedziczone po Command)
Add(Command)	Dodaje podpolecenia do polecenia . (Odziedziczone po Command)
Add(Option)	Dodaje element Option do polecenia . (Odziedziczone po Command)
AddAlias(String)	Dodaje alias. (Odziedziczone po IdentifierSymbol)
AddArgument(Argument)	Dodaje element Argument do polecenia . (Odziedziczone po Command)
AddCommand(Command)	Dodaje podpolecenia do polecenia . (Odziedziczone po Command)
AddGlobalOption(Option)	Dodaje element globalny Option do polecenia . (Odziedziczone po Command)
AddOption(Option)	Dodaje element Option do polecenia . (Odziedziczone po Command)
AddValidator(ValidateSymbolResult<CommandResult>)	Dodaje niestandardowy moduł sprawdzania poprawności do polecenia. Moduły sprawdzania poprawności mogą służyć do tworzenia niestandardowej logiki walidacji. (Odziedziczone po Command)
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetCompletions()	Pobiera uzupełnianie symbolu. (Odziedziczone po Symbol)
GetCompletions(CompletionContext)	Pobiera sugerowane wartości dla uzupełniania wiersza polecenia. (Odziedziczone po Command)
GetEnumerator()	Pobiera moduł wyliczający reprezentujący wszystkie symbole polecenia. (Odziedziczone po Command)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
HasAlias(String)	Określa, czy alias został już zdefiniowany. (Odziedziczone po IdentifierSymbol)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Symbol)

Jawne implementacje interfejsu

IEnumerable.GetEnumerator()

Zwraca moduł wyliczający, który iteruje po kolekcji. (Odziedziczone po Command)

Metody rozszerzania

Invoke(Command, String, IConsole)	Analizuje i wywołuje polecenie.
Invoke(Command, String[], IConsole)	Analizuje i wywołuje polecenie.
InvokeAsync(Command, String, IConsole)	Analizuje i wywołuje polecenie.
InvokeAsync(Command, String[], IConsole)	Analizuje i wywołuje polecenie.
Parse(Command, String)	Analizuje wartość ciągu wiersza polecenia przy użyciu określonego polecenia.
Parse(Command, String[])	Analizuje ciągi tablicy przy użyciu określonego polecenia.
SetHandler(Command, Action)	Ustawia procedurę obsługi poleceń na podstawie elementu Action.
SetHandler(Command, Func<Task>)	Ustawia procedurę obsługi poleceń na podstawie elementu Func<TResult>.
SetHandler<T>(Command, Action<T>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T>.
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>.
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2>.
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,TResult>.
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3>.
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,TResult>.
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4>.
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,TResult>.
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5>.
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])	Ustawia procedurę obsługi poleceń na podstawie elementu Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>.