RootCommand Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Rappresenta l'azione principale eseguita dall'applicazione.
public ref class RootCommand : System::CommandLine::Command
public class RootCommand : System.CommandLine.Command
type RootCommand = class
inherit Command
Public Class RootCommand
Inherits Command
- Ereditarietà
Commenti
Utilizzare l'oggetto RootCommand senza sottocomandi per le applicazioni che eseguono un'unica azione. Aggiungere sottocomandi alla radice per le applicazioni che richiedono azioni identificate da stringhe specifiche. Ad esempio, "dir" non usa sottocomandi. Vedere Command per le applicazioni con più azioni.
Costruttori
| Nome | Descrizione |
|---|---|
| RootCommand(String) |
Rappresenta l'azione principale eseguita dall'applicazione. |
Proprietà
| Nome | Descrizione |
|---|---|
| Action |
Ottiene o imposta l'oggetto CommandLineAction per l'oggetto Command. Il gestore rappresenta l'azione che verrà eseguita quando viene richiamato il comando. (Ereditato da Command) |
| Aliases |
Ottiene il set univoco di stringhe che è possibile utilizzare nella riga di comando per specificare il comando. (Ereditato da Command) |
| Arguments |
Ottiene tutti gli argomenti per il comando . (Ereditato da Command) |
| Children |
Ottiene i simboli figlio. (Ereditato da Command) |
| Description |
Ottiene o imposta la descrizione del simbolo. (Ereditato da Symbol) |
| Directives |
Rappresenta tutte le direttive valide nel comando radice. |
| ExecutableName |
Nome dell'eseguibile attualmente in esecuzione. |
| ExecutablePath |
Percorso dell'eseguibile attualmente in esecuzione. |
| Hidden |
Ottiene o imposta un valore che indica se il simbolo è nascosto. (Ereditato da Symbol) |
| Name |
Ottiene il nome del simbolo. (Ereditato da Symbol) |
| Options |
Ottiene tutte le opzioni per il comando. (Ereditato da Command) |
| Parents |
Ottiene i simboli padre. (Ereditato da Symbol) |
| Subcommands |
Ottiene tutti i sottocomandi per il comando. (Ereditato da Command) |
| TreatUnmatchedTokensAsErrors |
Ottiene o imposta un valore che indica se i token non corrispondenti devono essere considerati come errori. (Ereditato da Command) |
| Validators |
Ottiene i validator al comando. I validator possono essere usati per creare logica di convalida personalizzata. (Ereditato da Command) |
Metodi
| Nome | Descrizione |
|---|---|
| Add(Argument) |
Aggiunge un Argument oggetto al comando . (Ereditato da Command) |
| Add(Command) |
Aggiunge un Command oggetto al comando . (Ereditato da Command) |
| Add(Directive) |
Aggiunge un Directive oggetto al comando . |
| Add(Option) |
Aggiunge un oggetto Option al comando . (Ereditato da Command) |
| GetCompletions(CompletionContext) |
Ottiene i completamenti per il simbolo. (Ereditato da Command) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analizza le stringhe di matrice usando il comando . (Ereditato da Command) |
| Parse(String, ParserConfiguration) |
Analizza un valore stringa della riga di comando usando il comando . (Ereditato da Command) |
| SetAction(Action<ParseResult>) |
Imposta un'azione sincrona da eseguire quando viene richiamato il comando. (Ereditato da Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Imposta un'azione asincrona quando viene richiamato il comando. (Ereditato da Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Imposta un'azione asincrona da eseguire quando viene richiamato il comando. (Ereditato da Command) |
| SetAction(Func<ParseResult,Int32>) |
Imposta un'azione sincrona da eseguire quando viene richiamato il comando. (Ereditato da Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Imposta un'azione asincrona da eseguire quando viene richiamato il comando. (Ereditato da Command) |
| SetAction(Func<ParseResult,Task>) |
Imposta un'azione asincrona da eseguire quando viene richiamato il comando. (Ereditato da Command) |
| ToString() |
Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Symbol) |
Implementazioni dell'interfaccia esplicita
| Nome | Descrizione |
|---|---|
| IEnumerable.GetEnumerator() |
Restituisce un enumeratore che scorre un insieme. (Ereditato da Command) |