HelpOption Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Opción estándar que indica que se debe mostrar la ayuda de la línea de comandos.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Herencia
Constructores
| Nombre | Description |
|---|---|
| HelpOption() |
Cuando se agrega a , Commandconfigura la aplicación para mostrar ayuda cuando se especifica una de las siguientes opciones en la línea de comandos: |
| HelpOption(String, String[]) |
Cuando se agrega a , Commandconfigura la aplicación para mostrar ayuda cuando se especifica un nombre determinado o uno de los alias en la línea de comandos. |
Propiedades
| Nombre | Description |
|---|---|
| Action |
Obtiene o establece el para CommandLineAction la opción . El controlador representa la acción que se realizará cuando se invoque la opción. |
| Aliases |
Obtiene el conjunto único de cadenas que se pueden usar en la línea de comandos para especificar la opción. (Heredado de Option) |
| AllowMultipleArgumentsPerToken |
Obtiene un valor que indica si se permiten varios tokens de argumento para cada token de identificador de opción. (Heredado de Option) |
| Arity |
Obtiene o establece la aridad de la opción. (Heredado de Option) |
| CompletionSources |
Obtiene la lista de orígenes de finalización de la opción . (Heredado de Option) |
| Description |
Obtiene o establece la descripción del símbolo. (Heredado de Symbol) |
| HasDefaultValue |
Especifica si se define un valor predeterminado para la opción . (Heredado de Option) |
| HelpName |
Obtiene o establece el nombre del marcador de posición que se muestra en la ayuda de uso para el valor de la opción.
El valor se ajustará entre corchetes angulares ( |
| Hidden |
Obtiene o establece un valor que indica si el símbolo está oculto. (Heredado de Symbol) |
| Name |
Obtiene el nombre del símbolo. (Heredado de Symbol) |
| Parents |
Obtiene los símbolos primarios. (Heredado de Symbol) |
| Recursive |
Cuando se establece en true, esta opción se aplicará a su comando o comandos primarios inmediatos y de forma recursiva a sus subcomandos. (Heredado de Option) |
| Required |
Indica si la opción es necesaria cuando se invoca su comando primario. (Heredado de Option) |
| Validators |
Validadores a los que se llamará cuando el analizador coincida con la opción. (Heredado de Option) |
| ValueType |
Opción estándar que indica que se debe mostrar la ayuda de la línea de comandos. |
Métodos
| Nombre | Description |
|---|---|
| GetCompletions(CompletionContext) |
Obtiene finalizaciones para el símbolo. (Heredado de Option) |
| GetDefaultValue() |
Obtiene el valor predeterminado de la opción . (Heredado de Option) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Symbol) |
