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 class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
type Command = class
inherit Symbol
interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
- 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. |
| Arguments |
Obtient tous les arguments de la commande. |
| Children |
Obtient les symboles enfants. |
| Description |
Obtient ou définit la description du symbole. (Hérité de Symbol) |
| Hidden |
Obtient ou définit une valeur indiquant si le symbole est masqué. (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) |
| 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. |
| GetCompletions(CompletionContext) |
Obtient les achèvements du symbole. |
| 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. |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Symbol) |
Implémentations d’interfaces explicites
| Nom | Description |
|---|---|
| IEnumerable.GetEnumerator() |
Retourne un énumérateur qui itère dans une collection. |