Command Osztály

Definíció

Névtér:

System.CommandLine

Szerelvény:

System.CommandLine.dll

Csomag:

System.CommandLine v3.0.0-preview.7.26381.103

Forrás:

Command.cs

Egy adott műveletet jelöl, amelyet az alkalmazás hajt végre.

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

Öröklődés

Object

Symbol

Command

Származtatott

System.CommandLine.RootCommand

System.CommandLine.StaticCompletions.CompletionsCommandDefinition

System.CommandLine.StaticCompletions.CompletionsGenerateScriptCommandDefinition

Megvalósítás

IEnumerable

Megjegyzések

Használja a Parancs objektumot egy adott sztringnek (a parancsnévnek) megfelelő műveletekhez. Az olyan egyszerű alkalmazások esetében, amelyek csak egy műveletet hajtanak végre, lásd: RootCommand. Például dotnet run parancsként használja run .

Konstruktorok

Name	Description
Command(String, String)	Inicializálja a Command osztály új példányát.

Tulajdonságok

Name	Description
Action	Lekéri vagy beállítja a CommandLineAction parancsot. A kezelő a parancs meghívásakor végrehajtandó műveletet jelöli.
Aliases	Lekéri a parancssorban a parancs megadásához használható egyedi sztringeket.
Arguments	Lekéri a parancs összes argumentumát.
Children	Lekéri a gyermek szimbólumokat.
Description	Lekéri vagy beállítja a szimbólum leírását. (Öröklődés forrása Symbol)
Hidden	Lekéri vagy beállít egy értéket, amely jelzi, hogy a szimbólum rejtett-e. (Öröklődés forrása Symbol)
Name	Lekéri a szimbólum nevét. (Öröklődés forrása Symbol)
Options	Lekéri a parancs összes beállítását.
Parents	Lekéri a szülőszimbólumokat. (Öröklődés forrása Symbol)
Subcommands	Lekéri a parancs összes alparancsát.
TreatUnmatchedTokensAsErrors	Olyan értéket kap vagy állít be, amely jelzi, hogy a nem egyező jogkivonatokat hibaként kell-e kezelni.
Validators	Lekéri az érvényesítőket a parancshoz. Az érvényesítők egyéni érvényesítési logika létrehozásához használhatók.

Metódusok

Name	Description
Add(Argument)	Hozzáad egy parancsot Argument .
Add(Command)	Hozzáad egy parancsot Command .
Add(Option)	Hozzáad egy parancsot Option .
GetCompletions(CompletionContext)	Befejezi a szimbólumot.
Parse(IReadOnlyList<String>, ParserConfiguration)	Tömbsztringek elemzése a parancs használatával.
Parse(String, ParserConfiguration)	Egy parancssori sztringérték elemzése a parancs használatával.
SetAction(Action<ParseResult>)	Beállít egy szinkron műveletet, amelyet a parancs meghívásakor kell futtatni.
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	A parancs meghívásakor aszinkron műveletet állít be.
SetAction(Func<ParseResult,CancellationToken,Task>)	A parancs meghívásakor futtatandó aszinkron műveletet állít be.
SetAction(Func<ParseResult,Int32>)	Beállít egy szinkron műveletet, amelyet a parancs meghívásakor kell futtatni.
SetAction(Func<ParseResult,Task<Int32>>)	A parancs meghívásakor futtatandó aszinkron műveletet állít be.
SetAction(Func<ParseResult,Task>)	A parancs meghívásakor futtatandó aszinkron műveletet állít be.
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Symbol)

Explicit interfész-implementációk

Name	Description
IEnumerable.GetEnumerator()	Egy gyűjteményen keresztül iteráló enumerátort ad vissza.

Bővítő metódusok

Name	Description
FunctionName(Command, String[])	Egyedi rendszerhéjfüggvénynév létrehozása parancshoz – ezeknek a neveknek eltér a "root" parancs nevétől (azaz nem szabad létrehozni a "dotnet" függvénynevet a bináris "dotnet" számára) a függvényhez való hozzáférés "elérési útja" alapján eltérő (ezért a parentCommandNames)
HierarchicalOptions(Command)	Egy adott műveletet jelöl, amelyet az alkalmazás hajt végre.
Names(Command)	Parancsok összes nevének lekérése, beleértve az elsődleges nevet és az összes aliast