RootCommand Klass

Definition

Namnområde:

System.CommandLine

Sammansättning:

System.CommandLine.dll

Paket:

System.CommandLine v3.0.0-preview.4.26230.115

Källa:

RootCommand.cs

Representerar den huvudsakliga åtgärd som programmet utför.

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

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Arv

Object

Symbol

Command

RootCommand

Kommentarer

Använd RootCommand-objektet utan underkommandon för program som utför en åtgärd. Lägg till underkommandon i roten för program som kräver åtgärder som identifieras av specifika strängar. Till exempel använder "dir" inga underkommandon. Se Command för program med flera åtgärder.

Konstruktorer

Name	Description
RootCommand(String)	Representerar den huvudsakliga åtgärd som programmet utför.

Egenskaper

Name	Description
Action	Hämtar eller anger CommandLineAction för kommandot. Hanteraren representerar den åtgärd som ska utföras när kommandot anropas. (Ärvd från Command)
Aliases	Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange kommandot. (Ärvd från Command)
Arguments	Hämtar alla argument för kommandot. (Ärvd från Command)
Children	Hämtar de underordnade symbolerna. (Ärvd från Command)
Description	Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol)
Directives	Representerar alla direktiv som är giltiga under rotkommandot.
ExecutableName	Namnet på den körbara filen som körs.
ExecutablePath	Sökvägen till den körbara filen som körs.
HelpName	Hämtar eller anger namnet som används för rotkommandot i hjälputdata.
Hidden	Hämtar eller anger ett värde som anger om symbolen är dold. (Ärvd från Symbol)
Name	Hämtar namnet på symbolen. (Ärvd från Symbol)
Options	Hämtar alla alternativ för kommandot. (Ärvd från Command)
Parents	Hämtar de överordnade symbolerna. (Ärvd från Symbol)
Subcommands	Hämtar alla underkommandon för kommandot. (Ärvd från Command)
TreatUnmatchedTokensAsErrors	Hämtar eller anger ett värde som anger om omatchade token ska behandlas som fel. (Ärvd från Command)
Validators	Hämtar validatorerna till kommandot. Validatorer kan användas för att skapa anpassad valideringslogik. (Ärvd från Command)

Metoder

Name	Description
Add(Argument)	Lägger till en Argument i kommandot. (Ärvd från Command)
Add(Command)	Lägger till en Command i kommandot. (Ärvd från Command)
Add(Directive)	Lägger till en Directive i kommandot.
Add(Option)	Lägger till en Option i kommandot. (Ärvd från Command)
GetCompletions(CompletionContext)	Hämtar slutföranden för symbolen. (Ärvd från Command)
Parse(IReadOnlyList<String>, ParserConfiguration)	Parsar en matrissträng med kommandot . (Ärvd från Command)
Parse(String, ParserConfiguration)	Parsar ett kommandoradssträngvärde med kommandot . (Ärvd från Command)
SetAction(Action<ParseResult>)	Anger en synkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command)
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	Anger en asynkron åtgärd när kommandot anropas. (Ärvd från Command)
SetAction(Func<ParseResult,CancellationToken,Task>)	Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command)
SetAction(Func<ParseResult,Int32>)	Anger en synkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command)
SetAction(Func<ParseResult,Task<Int32>>)	Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command)
SetAction(Func<ParseResult,Task>)	Anger en asynkron åtgärd som ska köras när kommandot anropas. (Ärvd från Command)
ToString()	Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Symbol)

Explicita gränssnittsimplementeringar

Name	Description
IEnumerable.GetEnumerator()	Returnerar en uppräknare som itererar genom en samling. (Ärvd från Command)