Jazyk

RootCommand Třída

Definice

Představuje hlavní akci, kterou aplikace provádí.

public ref class RootCommand : System::CommandLine::Command
public class RootCommand : System.CommandLine.Command
type RootCommand = class
    inherit Command
Public Class RootCommand
Inherits Command
Dědičnost
RootCommand

Poznámky

Použijte RootCommand objekt bez jakýchkoli dílčích příkazů pro aplikace, které provádějí jednu akci. Přidejte do kořenového adresáře podpříkazy pro aplikace, které vyžadují akce identifikované konkrétními řetězci. Například dir nepoužívá žádné podpříkazy. Podívejte se Command na aplikace s více akcemi.

Konstruktory

Název Description
RootCommand(String)

Představuje hlavní akci, kterou aplikace provádí.

Vlastnosti

Název Description
Action

Získá nebo nastaví CommandLineAction příkaz. Obslužná rutina představuje akci, která se provede při vyvolání příkazu.

(Zděděno od Command)
Aliases

Získá jedinečnou sadu řetězců, které lze použít na příkazovém řádku k určení příkazu.

(Zděděno od Command)
Arguments

Získá všechny argumenty pro příkaz.

(Zděděno od Command)
Children

Získá podřízené symboly.

(Zděděno od Command)
Description

Získá nebo nastaví popis symbolu.

(Zděděno od Symbol)
Directives

Představuje všechny direktivy platné pod kořenovým příkazem.

ExecutableName

Název aktuálně spuštěného spustitelného souboru.

ExecutablePath

Cesta k aktuálně spuštěném spustitelnému souboru.

HelpName

Získá nebo nastaví název použitý pro kořenový příkaz ve výstupu nápovědy.

Hidden

Získá nebo nastaví hodnotu označující, zda je symbol skrytý.

(Zděděno od Symbol)
Name

Získá název symbolu.

(Zděděno od Symbol)
Options

Získá všechny možnosti příkazu.

(Zděděno od Command)
Parents

Získá nadřazené symboly.

(Zděděno od Symbol)
Subcommands

Získá všechny podpříkazy pro příkaz.

(Zděděno od Command)
TreatUnmatchedTokensAsErrors

Získá nebo nastaví hodnotu, která označuje, zda mají být chybějící tokeny považovány za chyby.

(Zděděno od Command)
Validators

Získá validátory příkazu. Validátory lze použít k vytvoření vlastní logiky ověřování.

(Zděděno od Command)

Metody

Název Description
Add(Argument)

Argument Přidá do příkazu příkaz.

(Zděděno od Command)
Add(Command)

Command Přidá do příkazu příkaz.

(Zděděno od Command)
Add(Directive)

Directive Přidá do příkazu příkaz.

Add(Option)

Přidá do příkazu příkaz Option .

(Zděděno od Command)
GetCompletions(CompletionContext)

Získá dokončování symbolu.

(Zděděno od Command)
Parse(IReadOnlyList<String>, ParserConfiguration)

Parsuje řetězce pole pomocí příkazu.

(Zděděno od Command)
Parse(String, ParserConfiguration)

Parsuje hodnotu řetězce příkazového řádku pomocí příkazu.

(Zděděno od Command)
SetAction(Action<ParseResult>)

Nastaví synchronní akci, která se spustí při vyvolání příkazu.

(Zděděno od Command)
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)

Nastaví asynchronní akci při vyvolání příkazu.

(Zděděno od Command)
SetAction(Func<ParseResult,CancellationToken,Task>)

Nastaví asynchronní akci, která se má spustit při vyvolání příkazu.

(Zděděno od Command)
SetAction(Func<ParseResult,Int32>)

Nastaví synchronní akci, která se spustí při vyvolání příkazu.

(Zděděno od Command)
SetAction(Func<ParseResult,Task<Int32>>)

Nastaví asynchronní akci, která se má spustit při vyvolání příkazu.

(Zděděno od Command)
SetAction(Func<ParseResult,Task>)

Nastaví asynchronní akci, která se má spustit při vyvolání příkazu.

(Zděděno od Command)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Symbol)

Explicitní implementace rozhraní

Název Description
IEnumerable.GetEnumerator()

Vrátí enumerátor, který iteruje kolekcí.

(Zděděno od Command)

Metody rozšíření

Název Description
ConfigureFromMethod(Command, MethodInfo, Object)

Představuje hlavní akci, kterou aplikace provádí.

FunctionName(Command, String[])

Vytvoření jedinečného názvu funkce prostředí pro příkaz – tyto názvy by měly být

  • odlišné od názvu kořenového příkazu (tj. neměli bychom generovat název funkce dotnet pro binární dotnet).
  • distinct based on 'path' to get to this function (proto parentCommandNames)
HierarchicalOptions(Command)

Představuje hlavní akci, kterou aplikace provádí.

Names(Command)

Získání všech názvů pro příkaz, včetně primárního názvu a všech aliasů

UseCommandHandler<THandler>(Command)

Představuje hlavní akci, kterou aplikace provádí.

Platí pro