HelpOption 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.
Opzione standard che indica che deve essere visualizzata la Guida della riga di comando.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Ereditarietà
Costruttori
| Nome | Descrizione |
|---|---|
| HelpOption() |
Quando viene aggiunto a , Commandconfigura l'applicazione per visualizzare la Guida quando viene specificata una delle opzioni seguenti nella riga di comando: |
| HelpOption(String, String[]) |
Quando viene aggiunto a , Commandconfigura l'applicazione per visualizzare la Guida quando viene specificato il nome o uno degli alias nella riga di comando. |
Proprietà
| Nome | Descrizione |
|---|---|
| Action |
Ottiene o imposta l'oggetto CommandLineAction per l'opzione. Il gestore rappresenta l'azione che verrà eseguita quando viene richiamata l'opzione. |
| Aliases |
Ottiene il set univoco di stringhe che è possibile utilizzare nella riga di comando per specificare l'opzione. (Ereditato da Option) |
| AllowMultipleArgumentsPerToken |
Ottiene un valore che indica se sono consentiti più token di argomento per ogni token di identificatore di opzione. (Ereditato da Option) |
| Arity |
Ottiene o imposta l'arità dell'opzione. (Ereditato da Option) |
| CompletionSources |
Ottiene l'elenco delle origini di completamento per l'opzione . (Ereditato da Option) |
| Description |
Ottiene o imposta la descrizione del simbolo. (Ereditato da Symbol) |
| HasDefaultValue |
Specifica se per l'opzione è definito un valore predefinito. (Ereditato da Option) |
| HelpName |
Ottiene o imposta il nome segnaposto visualizzato nella Guida all'utilizzo per il valore dell'opzione.
Il valore verrà racchiuso tra parentesi angolari ( |
| Hidden |
Ottiene o imposta un valore che indica se il simbolo è nascosto. (Ereditato da Symbol) |
| Name |
Ottiene il nome del simbolo. (Ereditato da Symbol) |
| Parents |
Ottiene i simboli padre. (Ereditato da Symbol) |
| Recursive |
Se impostato su true, questa opzione verrà applicata al comando o ai comandi padre immediati e in modo ricorsivo ai relativi sottocomandi. (Ereditato da Option) |
| Required |
Indica se l'opzione è necessaria quando viene richiamato il relativo comando padre. (Ereditato da Option) |
| Validators |
Validator che verranno chiamati quando l'opzione corrisponde al parser. (Ereditato da Option) |
| ValueType |
Opzione standard che indica che deve essere visualizzata la Guida della riga di comando. |
Metodi
| Nome | Descrizione |
|---|---|
| GetCompletions(CompletionContext) |
Ottiene i completamenti per il simbolo. (Ereditato da Option) |
| GetDefaultValue() |
Ottiene il valore predefinito per l'opzione . (Ereditato da Option) |
| ToString() |
Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Symbol) |
