RootCommand Classe
Définition
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 principale effectuée par l’application.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Héritage
Remarques
Utilisez l’objet RootCommand sans sous-commande pour les applications qui effectuent une 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 Command les applications avec plusieurs actions.
Constructeurs
| Nom | Description |
|---|---|
| RootCommand(String) |
Représente l’action principale effectuée par l’application. |
Propriétés
| Nom | Description |
|---|---|
| Action |
Obtient ou définit la CommandLineAction commande. Le gestionnaire représente l’action qui sera effectuée lorsque la commande est appelée. (Hérité de Command) |
| Aliases |
Obtient l’ensemble unique de chaînes qui peuvent être utilisées sur la ligne de commande pour spécifier la commande. (Hérité de Command) |
| Argument |
Obsolète.
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| Arguments |
Obtient 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) |
| Directives |
Représente toutes les directives valides sous la commande racine. |
| ExecutableName |
Nom de l’exécutable en cours d’exécution. |
| ExecutablePath |
Chemin d’accès à l’exécutable en cours d’exécution. |
| ExeName |
Représente l’action principale effectuée par l’application. |
| ExePath |
Représente l’action principale effectuée par l’application. |
| Handler |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| HelpName |
Obtient ou définit le nom utilisé pour la commande racine dans la sortie d’aide. |
| Hidden |
Obtient ou définit une valeur indiquant si le symbole est masqué. (Hérité de Symbol) |
| IsHidden |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| Name |
Représente l’action principale effectuée par l’application. |
| Name |
Obtient le nom du symbole. (Hérité de Symbol) |
| Options |
Obtient toutes les options de la commande. (Hérité de Command) |
| Parents |
Obtient les symboles parents. (Hérité de Symbol) |
| RawAliases |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| Subcommands |
Obtient 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. (Hérité de Command) |
| Validators |
Obtient les validateurs dans la commande. Les validateurs peuvent être utilisés pour créer une logique de validation personnalisée. (Hérité de Command) |
Méthodes
| Nom | Description |
|---|---|
| Add(Argument) |
Ajoute une Argument à la commande. (Hérité de Command) |
| Add(Command) |
Ajoute une Command à la commande. (Hérité de Command) |
| Add(Directive) |
Ajoute une Directive à la commande. |
| Add(Option) |
Ajoute une Option commande. (Hérité de Command) |
| Add(Symbol) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| AddAlias(String) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| AddAliasInner(String) |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| AddArgument(Argument) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| AddCommand(Command) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| AddOption(Option) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| ClearAliases() |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| GetCompletions(CompletionContext) |
Obtient les achèvements du symbole. (Hérité de Command) |
| GetEnumerator() |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| HasAlias(String) |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| HasRawAlias(String) |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analyse une chaîne de tableau à l’aide de la commande. (Hérité de Command) |
| Parse(String, ParserConfiguration) |
Analyse une valeur de chaîne de ligne de commande à l’aide de la commande. (Hérité de Command) |
| SetAction(Action<ParseResult>) |
Définit une action synchrone à exécuter lorsque la commande est appelée. (Hérité de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Définit une action asynchrone lorsque la commande est appelée. (Hérité de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. (Hérité de Command) |
| SetAction(Func<ParseResult,Int32>) |
Définit une action synchrone à exécuter lorsque la commande est appelée. (Hérité de Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. (Hérité de Command) |
| SetAction(Func<ParseResult,Task>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. (Hérité de Command) |
| Suggest(String) |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Symbol) |
Implémentations d’interfaces explicites
| Nom | Description |
|---|---|
| ICommand.Argument |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| ICommand.Arguments |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| ICommand.Options |
Représente l’action principale effectuée par l’application. (Hérité de Command) |
| IEnumerable.GetEnumerator() |
Retourne un énumérateur qui itère dans une collection. (Hérité de Command) |
| ISymbol.Children |
Représente l’action principale effectuée par l’application. (Hérité de Symbol) |
Méthodes d’extension
| Nom | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Représente l’action principale effectuée par l’application. |
| Invoke(Command, String, IConsole) |
Représente l’action principale effectuée par l’application. |
| Invoke(Command, String[], IConsole) |
Représente l’action principale effectuée par l’application. |
| InvokeAsync(Command, String, IConsole) |
Représente l’action principale effectuée par l’application. |
| InvokeAsync(Command, String[], IConsole) |
Représente l’action principale effectuée par l’application. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Représente l’action principale effectuée par l’application. |
| Parse(Command, String[]) |
Représente l’action principale effectuée par l’application. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Convertit un IEnumerable<T> en IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Crée un FrozenDictionary<TKey,TValue> à partir d’un IEnumerable<T> en fonction des fonctions de sélecteur de clé et de sélecteur d’élément spécifiées. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Crée un FrozenDictionary<TKey,TValue> à partir d’un IEnumerable<T> en fonction de la fonction de sélecteur de clé spécifiée. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Crée un FrozenSet<T> avec les valeurs spécifiées. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Crée un tableau immuable à partir de la collection spécifiée. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Énumère et transforme une séquence et produit un dictionnaire immuable de son contenu à l’aide des comparateurs de clé et de valeur spécifiés. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Énumère et transforme une séquence et produit un dictionnaire immuable de son contenu à l’aide du comparateur de clés spécifié. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Énumère et transforme une séquence et produit un dictionnaire immuable de son contenu. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Construit un dictionnaire immuable basé sur une transformation d’une séquence. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Construit un dictionnaire immuable à partir d’une collection existante d’éléments, en appliquant une fonction de transformation aux clés sources. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Énumère une séquence, produit un jeu de hachage immuable de son contenu et utilise le comparateur d’égalité spécifié pour le type set. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Énumère une séquence et produit un ensemble de hachage immuable de son contenu. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Énumère une séquence et produit une liste immuable de son contenu. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Énumère et transforme une séquence et produit un dictionnaire trié immuable de son contenu à l’aide des comparateurs de clé et de valeur spécifiés. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Énumère et transforme une séquence et produit un dictionnaire trié immuable de son contenu à l’aide du comparateur de clés spécifié. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Énumère et transforme une séquence et produit un dictionnaire trié immuable de son contenu. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Énumère une séquence, produit un ensemble trié immuable de son contenu et utilise le comparateur spécifié. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Énumère une séquence et produit un ensemble trié immuable de son contenu. |
| UseCommandHandler<THandler>(Command) |
Représente l’action principale effectuée par l’application. |
