RootCommand Klasa

Definicja

Przestrzeń nazw:

System.CommandLine

Zestaw:

System.CommandLine.dll

Pakiet:

System.CommandLine v3.0.0-preview.2.26159.112

Źródło:

RootCommand.cs

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

Command

RootCommand

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

Nazwa	Opis
RootCommand(String)	Reprezentuje akcję główną wykonywaną przez aplikację.

Właściwości

Nazwa	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)
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.
Hidden	Pobiera lub ustawia wartość wskazującą, czy symbol jest ukryty. (Odziedziczone po Symbol)
Name	Pobiera nazwę symbolu. (Odziedziczone po Symbol)
Options	Pobiera wszystkie opcje polecenia. (Odziedziczone po Command)
Parents	Pobiera symbole nadrzędne. (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

Nazwa	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)
GetCompletions(CompletionContext)	Pobiera uzupełnienia symbolu. (Odziedziczone po Command)
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)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Symbol)

Jawne implementacje interfejsu

Nazwa	Opis
IEnumerable.GetEnumerator()	Zwraca moduł wyliczający, który iteruje za pośrednictwem kolekcji. (Odziedziczone po Command)