Command 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 une action spécifique effectuée par l’application.
public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable
public ref class Command : System::CommandLine::Symbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>, System::CommandLine::ICommand
public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
public class Command : System.CommandLine.Symbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>, System.CommandLine.ICommand
type Command = class
inherit Symbol
interface IEnumerable
type Command = class
inherit Symbol
interface ICommand
interface ISymbol
interface ISuggestionSource
interface seq<Symbol>
interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
Public Class Command
Inherits Symbol
Implements ICommand, IEnumerable(Of Symbol)
- Héritage
- Dérivé
- Implémente
Remarques
Utilisez l’objet Command pour les actions qui correspondent à une chaîne spécifique (nom de la commande). Pour les applications simples qui n’ont qu’une seule action, consultez RootCommand. Par exemple, dotnet run utilise run comme commande.
Constructeurs
| Nom | Description |
|---|---|
| Command(String, String) |
Initialise une nouvelle instance de la classe Command. |
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. |
| Aliases |
Obtient l’ensemble unique de chaînes qui peuvent être utilisées sur la ligne de commande pour spécifier la commande. |
| Aliases |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| Argument |
Obsolète.
Représente une action spécifique effectuée par l’application. |
| Arguments |
Obtient tous les arguments de la commande. |
| Children |
Obtient les symboles enfants. |
| Children |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| Description |
Obtient ou définit la description du symbole. (Hérité de Symbol) |
| Handler |
Représente une action spécifique effectuée par l’application. |
| Hidden |
Obtient ou définit une valeur indiquant si le symbole est masqué. (Hérité de Symbol) |
| IsHidden |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| Name |
Obtient le nom du symbole. (Hérité de Symbol) |
| Options |
Obtient toutes les options de la commande. |
| Parents |
Obtient les symboles parents. (Hérité de Symbol) |
| RawAliases |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| Subcommands |
Obtient toutes les sous-commandes de la commande. |
| TreatUnmatchedTokensAsErrors |
Obtient ou définit une valeur qui indique si les jetons sans correspondance doivent être traités comme des erreurs. |
| Validators |
Obtient les validateurs dans la commande. Les validateurs peuvent être utilisés pour créer une logique de validation personnalisée. |
Méthodes
| Nom | Description |
|---|---|
| Add(Argument) |
Ajoute une Argument à la commande. |
| Add(Command) |
Ajoute une Command à la commande. |
| Add(Option) |
Ajoute une Option commande. |
| Add(Symbol) |
Représente une action spécifique effectuée par l’application. |
| AddAlias(String) |
Représente une action spécifique effectuée par l’application. |
| AddAliasInner(String) |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| AddArgument(Argument) |
Représente une action spécifique effectuée par l’application. |
| AddCommand(Command) |
Représente une action spécifique effectuée par l’application. |
| AddOption(Option) |
Représente une action spécifique effectuée par l’application. |
| AddValidator(ValidateSymbol<CommandResult>) |
Représente une action spécifique effectuée par l’application. |
| ClearAliases() |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| GetCompletions(CompletionContext) |
Obtient les achèvements du symbole. |
| GetEnumerator() |
Représente une action spécifique effectuée par l’application. |
| HasAlias(String) |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| HasRawAlias(String) |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analyse une chaîne de tableau à l’aide de la commande. |
| Parse(String, ParserConfiguration) |
Analyse une valeur de chaîne de ligne de commande à l’aide de la commande. |
| SetAction(Action<ParseResult>) |
Définit une action synchrone à exécuter lorsque la commande est appelée. |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Définit une action asynchrone lorsque la commande est appelée. |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. |
| SetAction(Func<ParseResult,Int32>) |
Définit une action synchrone à exécuter lorsque la commande est appelée. |
| SetAction(Func<ParseResult,Task<Int32>>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. |
| SetAction(Func<ParseResult,Task>) |
Définit une action asynchrone à exécuter lorsque la commande est appelée. |
| Suggest(String) |
Représente une action spécifique 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 une action spécifique effectuée par l’application. |
| ICommand.Arguments |
Représente une action spécifique effectuée par l’application. |
| ICommand.Options |
Représente une action spécifique effectuée par l’application. |
| IEnumerable.GetEnumerator() |
Retourne un énumérateur qui itère dans une collection. |
| ISymbol.Children |
Représente une action spécifique effectuée par l’application. (Hérité de Symbol) |
Méthodes d’extension
| Nom | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Représente une action spécifique effectuée par l’application. |
| Invoke(Command, String, IConsole) |
Représente une action spécifique effectuée par l’application. |
| Invoke(Command, String[], IConsole) |
Représente une action spécifique effectuée par l’application. |
| InvokeAsync(Command, String, IConsole) |
Représente une action spécifique effectuée par l’application. |
| InvokeAsync(Command, String[], IConsole) |
Représente une action spécifique effectuée par l’application. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Représente une action spécifique effectuée par l’application. |
| Parse(Command, String[]) |
Représente une action spécifique 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 une action spécifique effectuée par l’application. |