RootCommand Classe

Référence

Définition

Espace de noms:: System.CommandLine

Assembly:: System.CommandLine.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Représente l’action main effectuée par l’application.

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

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Héritage: Object

Symbol

IdentifierSymbol

Command
RootCommand

Remarques

Utilisez l’objet RootCommand sans sous-commandes pour les applications qui effectuent une seule action. Ajoutez des sous-commandes à la racine pour les applications qui nécessitent des actions identifiées par des chaînes spécifiques. Par exemple, 'dir' n’utilise aucune sous-commande. Consultez pour les Command applications avec plusieurs actions.

Constructeurs

RootCommand(String)

Représente l’action main effectuée par l’application.

Propriétés

Aliases	Obtient l’ensemble de chaînes qui peuvent être utilisées sur la ligne de commande pour spécifier le symbole. (Hérité de IdentifierSymbol)
Arguments	Représente tous les arguments de la commande. (Hérité de Command)
Children	Obtient les symboles enfants. (Hérité de Command)
Description	Obtient ou définit la description du symbole. (Hérité de Symbol)
ExecutableName	Nom de l’exécutable en cours d’exécution.
ExecutablePath	Chemin d’accès à l’exécutable en cours d’exécution.
Handler	Obtient ou définit le ICommandHandler pour la commande . Le gestionnaire représente l’action qui sera effectuée lorsque la commande est appelée. (Hérité de Command)
IsHidden	Obtient ou définit une valeur indiquant si le symbole est masqué. (Hérité de Symbol)
Name	Obtient ou définit le nom du symbole. (Hérité de IdentifierSymbol)
Options	Représente toutes les options de la commande, y compris les options globales qui ont été appliquées à l’un des ancêtres de la commande. (Hérité de Command)
Parents	Obtient les symboles parent. (Hérité de Symbol)
Subcommands	Représente toutes les sous-commandes de la commande. (Hérité de Command)
TreatUnmatchedTokensAsErrors	Obtient ou définit une valeur qui indique si les jetons sans correspondance doivent être traités comme des erreurs. Par exemple, si la valeur est définie `true` sur et qu’une commande ou un argument supplémentaire est fourni, la validation échoue. (Hérité de Command)

Méthodes

Add(Argument)	Ajoute un Argument à la commande . (Hérité de Command)
Add(Command)	Ajoute une sous-commande à la commande . (Hérité de Command)
Add(Option)	Ajoute un Option à la commande . (Hérité de Command)
AddAlias(String)	Ajoute un alias. (Hérité de IdentifierSymbol)
AddArgument(Argument)	Ajoute un Argument à la commande . (Hérité de Command)
AddCommand(Command)	Ajoute une sous-commande à la commande . (Hérité de Command)
AddGlobalOption(Option)	Ajoute un global Option à la commande. (Hérité de Command)
AddOption(Option)	Ajoute un Option à la commande . (Hérité de Command)
AddValidator(ValidateSymbolResult<CommandResult>)	Ajoute un validateur personnalisé à la commande. Les validateurs peuvent être utilisés pour créer une logique de validation personnalisée. (Hérité de Command)
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetCompletions()	Obtient des achèvements pour le symbole. (Hérité de Symbol)
GetCompletions(CompletionContext)	Obtient les valeurs suggérées pour l’achèvement de la ligne de commande. (Hérité de Command)
GetEnumerator()	Obtient un énumérateur qui représente tous les symboles de la commande. (Hérité de Command)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
HasAlias(String)	Détermine si l’alias a déjà été défini. (Hérité de IdentifierSymbol)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Symbol)

Implémentations d’interfaces explicites

IEnumerable.GetEnumerator()

Retourne un énumérateur qui itère au sein d’une collection.

(Hérité de Command)

Méthodes d’extension

Invoke(Command, String, IConsole)	Analyse et appelle une commande.
Invoke(Command, String[], IConsole)	Analyse et appelle une commande.
InvokeAsync(Command, String, IConsole)	Analyse et appelle une commande.
InvokeAsync(Command, String[], IConsole)	Analyse et appelle une commande.
Parse(Command, String)	Analyse une valeur de chaîne de ligne de commande à l’aide de la commande spécifiée.
Parse(Command, String[])	Analyse les chaînes d’un tableau à l’aide de la commande spécifiée.
SetHandler(Command, Action)	Définit le gestionnaire d’une commande en fonction d’un Action.
SetHandler(Command, Func<Task>)	Définit le gestionnaire d’une commande en fonction d’un Func<TResult>.
SetHandler<T>(Command, Action<T>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T>.
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>.
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2>.
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,TResult>.
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3>.
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,TResult>.
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4>.
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,TResult>.
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5>.
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])	Définit le gestionnaire d’une commande en fonction d’un Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>.

S’applique à