Sdílet prostřednictvím


Command Třída

Definice

Představuje konkrétní akci, kterou aplikace provede.

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable
public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
type Command = class
    inherit Symbol
    interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
Dědičnost
Command
Odvozené
Implementuje

Poznámky

Použijte objekt Command pro akce, které odpovídají určitému řetězci (název příkazu). Jednoduché aplikace, které mají pouze jednu akci, naleznete v tématu RootCommand. Například dotnet run se používá run jako příkaz.

Konstruktory

Name Description
Command(String, String)

Inicializuje novou instanci třídy Command.

Vlastnosti

Name Description
Action

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

Aliases

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

Arguments

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

Children

Získá podřízené symboly.

Description

Získá nebo nastaví popis symbolu.

(Zděděno od Symbol)
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.

Parents

Získá nadřazené symboly.

(Zděděno od Symbol)
Subcommands

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

TreatUnmatchedTokensAsErrors

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

Validators

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

Metody

Name Description
Add(Argument)

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

Add(Command)

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

Add(Option)

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

GetCompletions(CompletionContext)

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

Parse(IReadOnlyList<String>, ParserConfiguration)

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

Parse(String, ParserConfiguration)

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

SetAction(Action<ParseResult>)

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

SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)

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

SetAction(Func<ParseResult,CancellationToken,Task>)

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

SetAction(Func<ParseResult,Int32>)

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

SetAction(Func<ParseResult,Task<Int32>>)

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

SetAction(Func<ParseResult,Task>)

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

ToString()

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

(Zděděno od Symbol)

Explicitní implementace rozhraní

Name Description
IEnumerable.GetEnumerator()

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

Platí pro