RootCommand 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í.
Representa la acción principal que realiza la aplicación.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Herencia
Comentarios
Use el objeto RootCommand sin subcomandos para las aplicaciones que realizan una acción. Agregue subcomandos a la raíz de las aplicaciones que requieren acciones identificadas por cadenas específicas. Por ejemplo, "dir" no usa ningún subcomando. Consulte Command para aplicaciones con varias acciones.
Constructores
| Nombre | Description |
|---|---|
| RootCommand(String) |
Representa la acción principal que realiza la aplicación. |
Propiedades
| Nombre | Description |
|---|---|
| Action |
Obtiene o establece para CommandLineAction el objeto Command. El controlador representa la acción que se realizará cuando se invoque el comando. (Heredado de Command) |
| Aliases |
Obtiene el conjunto único de cadenas que se pueden usar en la línea de comandos para especificar el comando. (Heredado de Command) |
| Argument |
Obsoletos.
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| Arguments |
Obtiene todos los argumentos del comando . (Heredado de Command) |
| Children |
Obtiene los símbolos secundarios. (Heredado de Command) |
| Description |
Obtiene o establece la descripción del símbolo. (Heredado de Symbol) |
| Directives |
Representa todas las directivas que son válidas en el comando raíz. |
| ExecutableName |
Nombre del ejecutable que se está ejecutando actualmente. |
| ExecutablePath |
Ruta de acceso al archivo ejecutable que se está ejecutando actualmente. |
| ExeName |
Representa la acción principal que realiza la aplicación. |
| ExePath |
Representa la acción principal que realiza la aplicación. |
| Handler |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| HelpName |
Obtiene o establece el nombre usado para el comando raíz en la salida de la ayuda. |
| Hidden |
Obtiene o establece un valor que indica si el símbolo está oculto. (Heredado de Symbol) |
| IsHidden |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| Name |
Representa la acción principal que realiza la aplicación. |
| Name |
Obtiene el nombre del símbolo. (Heredado de Symbol) |
| Options |
Obtiene todas las opciones del comando . (Heredado de Command) |
| Parents |
Obtiene los símbolos primarios. (Heredado de Symbol) |
| RawAliases |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| Subcommands |
Obtiene todos los subcomandos del comando . (Heredado de Command) |
| TreatUnmatchedTokensAsErrors |
Obtiene o establece un valor que indica si los tokens no coincidentes deben tratarse como errores. (Heredado de Command) |
| Validators |
Obtiene los validadores del comando . Los validadores se pueden usar para crear lógica de validación personalizada. (Heredado de Command) |
Métodos
| Nombre | Description |
|---|---|
| Add(Argument) |
Agrega un Argument objeto al comando . (Heredado de Command) |
| Add(Command) |
Agrega un Command objeto al comando . (Heredado de Command) |
| Add(Directive) |
Agrega un Directive objeto al comando . |
| Add(Option) |
Agrega un Option objeto al comando . (Heredado de Command) |
| Add(Symbol) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| AddAlias(String) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| AddAliasInner(String) |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| AddArgument(Argument) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| AddCommand(Command) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| AddOption(Option) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| ClearAliases() |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| GetCompletions(CompletionContext) |
Obtiene finalizaciones para el símbolo. (Heredado de Command) |
| GetEnumerator() |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| HasAlias(String) |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| HasRawAlias(String) |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analiza una cadena de matriz mediante el comando . (Heredado de Command) |
| Parse(String, ParserConfiguration) |
Analiza un valor de cadena de línea de comandos mediante el comando . (Heredado de Command) |
| SetAction(Action<ParseResult>) |
Establece una acción sincrónica que se ejecutará cuando se invoca el comando. (Heredado de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Establece una acción asincrónica cuando se invoca el comando. (Heredado de Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Establece una acción asincrónica que se va a ejecutar cuando se invoca el comando. (Heredado de Command) |
| SetAction(Func<ParseResult,Int32>) |
Establece una acción sincrónica que se ejecutará cuando se invoca el comando. (Heredado de Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Establece una acción asincrónica que se va a ejecutar cuando se invoca el comando. (Heredado de Command) |
| SetAction(Func<ParseResult,Task>) |
Establece una acción asincrónica que se va a ejecutar cuando se invoca el comando. (Heredado de Command) |
| Suggest(String) |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Symbol) |
Implementaciones de interfaz explícitas
| Nombre | Description |
|---|---|
| ICommand.Argument |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| ICommand.Arguments |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| ICommand.Options |
Representa la acción principal que realiza la aplicación. (Heredado de Command) |
| IEnumerable.GetEnumerator() |
Devuelve un enumerador que recorre en iteración una colección. (Heredado de Command) |
| ISymbol.Children |
Representa la acción principal que realiza la aplicación. (Heredado de Symbol) |
Métodos de extensión
| Nombre | Description |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Representa la acción principal que realiza la aplicación. |
| Invoke(Command, String, IConsole) |
Representa la acción principal que realiza la aplicación. |
| Invoke(Command, String[], IConsole) |
Representa la acción principal que realiza la aplicación. |
| InvokeAsync(Command, String, IConsole) |
Representa la acción principal que realiza la aplicación. |
| InvokeAsync(Command, String[], IConsole) |
Representa la acción principal que realiza la aplicación. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Representa la acción principal que realiza la aplicación. |
| Parse(Command, String[]) |
Representa la acción principal que realiza la aplicación. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Convierte un IEnumerable<T> en un IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Crea un FrozenDictionary<TKey,TValue> a partir de un IEnumerable<T> según las funciones especificadas del selector de claves y del selector de elementos. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Crea un FrozenDictionary<TKey,TValue> objeto a partir de una IEnumerable<T> función de selector de claves especificada. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Crea un FrozenSet<T> objeto con los valores especificados. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Crea una matriz inmutable a partir de la colección especificada. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Enumera y transforma una secuencia y genera un diccionario inmutable de su contenido mediante los comparadores de clave y valor especificados. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Enumera y transforma una secuencia y genera un diccionario inmutable de su contenido mediante el comparador de claves especificado. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumera y transforma una secuencia y genera un diccionario inmutable de su contenido. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Construye un diccionario inmutable basado en alguna transformación de una secuencia. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Construye un diccionario inmutable a partir de una colección de elementos existente, aplicando una función de transformación a las claves de origen. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Enumera una secuencia, genera un conjunto hash inmutable de su contenido y usa el comparador de igualdad especificado para el tipo de conjunto. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Enumera una secuencia y genera un conjunto hash inmutable de su contenido. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Enumera una secuencia y genera una lista inmutable de su contenido. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Enumera y transforma una secuencia y genera un diccionario ordenado inmutable de su contenido mediante los comparadores de clave y valor especificados. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Enumera y transforma una secuencia y genera un diccionario ordenado inmutable de su contenido mediante el comparador de claves especificado. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumera y transforma una secuencia y genera un diccionario ordenado inmutable de su contenido. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Enumera una secuencia, genera un conjunto ordenado inmutable de su contenido y usa el comparador especificado. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Enumera una secuencia y genera un conjunto ordenado inmutable de su contenido. |
| UseCommandHandler<THandler>(Command) |
Representa la acción principal que realiza la aplicación. |
