RootCommand Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет основное действие, которое выполняет приложение.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Наследование
Комментарии
Используйте объект RootCommand без вложенных команд для приложений, выполняющих одно действие. Добавьте вложенные команды в корневой каталог для приложений, требующих действий, определенных определенными строками. Например, "dir" не использует подкоманда. См Command . сведения о приложениях с несколькими действиями.
Конструкторы
| Имя. | Описание |
|---|---|
| RootCommand(String) |
Представляет основное действие, которое выполняет приложение. |
Свойства
| Имя. | Описание |
|---|---|
| Action |
Возвращает или задает CommandLineAction для команды. Обработчик представляет действие, которое будет выполняться при вызове команды. (Унаследовано от Command) |
| Aliases |
Возвращает уникальный набор строк, которые можно использовать в командной строке для указания команды. (Унаследовано от Command) |
| Argument |
Устаревшие.
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| Arguments |
Возвращает все аргументы для команды. (Унаследовано от Command) |
| Children |
Возвращает дочерние символы. (Унаследовано от Command) |
| Description |
Возвращает или задает описание символа. (Унаследовано от Symbol) |
| Directives |
Представляет все директивы, допустимые в корневой команде. |
| ExecutableName |
Имя выполняемого в настоящее время исполняемого файла. |
| ExecutablePath |
Путь к исполняемому файлу, работающему в данный момент. |
| ExeName |
Представляет основное действие, которое выполняет приложение. |
| ExePath |
Представляет основное действие, которое выполняет приложение. |
| Handler |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| HelpName |
Возвращает или задает имя, используемое для корневой команды в выходных данных справки. |
| Hidden |
Возвращает или задает значение, указывающее, скрыт ли символ. (Унаследовано от Symbol) |
| IsHidden |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| Name |
Представляет основное действие, которое выполняет приложение. |
| Name |
Возвращает имя символа. (Унаследовано от Symbol) |
| Options |
Возвращает все параметры для команды. (Унаследовано от Command) |
| Parents |
Возвращает родительские символы. (Унаследовано от Symbol) |
| RawAliases |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| Subcommands |
Возвращает все вложенные команды. (Унаследовано от Command) |
| TreatUnmatchedTokensAsErrors |
Возвращает или задает значение, указывающее, следует ли рассматривать несоответствованные маркеры как ошибки. (Унаследовано от Command) |
| Validators |
Возвращает проверяющие элементы в команду. Проверяющие элементы можно использовать для создания пользовательской логики проверки. (Унаследовано от Command) |
Методы
| Имя. | Описание |
|---|---|
| Add(Argument) |
Добавляет команду Argument . (Унаследовано от Command) |
| Add(Command) |
Добавляет команду Command . (Унаследовано от Command) |
| Add(Directive) |
Добавляет команду Directive . |
| Add(Option) |
Добавляет команду Option . (Унаследовано от Command) |
| Add(Symbol) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| AddAlias(String) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| AddAliasInner(String) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| AddArgument(Argument) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| AddCommand(Command) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| AddOption(Option) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| ClearAliases() |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| GetCompletions(CompletionContext) |
Возвращает завершения для символа. (Унаследовано от Command) |
| GetEnumerator() |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| HasAlias(String) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| HasRawAlias(String) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Анализирует строки массива с помощью команды. (Унаследовано от Command) |
| Parse(String, ParserConfiguration) |
Анализирует строковое значение командной строки с помощью команды. (Унаследовано от Command) |
| SetAction(Action<ParseResult>) |
Задает синхронное действие, выполняемое при вызове команды. (Унаследовано от Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Задает асинхронное действие при вызове команды. (Унаследовано от Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Задает асинхронное действие, выполняемое при вызове команды. (Унаследовано от Command) |
| SetAction(Func<ParseResult,Int32>) |
Задает синхронное действие, выполняемое при вызове команды. (Унаследовано от Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Задает асинхронное действие, выполняемое при вызове команды. (Унаследовано от Command) |
| SetAction(Func<ParseResult,Task>) |
Задает асинхронное действие, выполняемое при вызове команды. (Унаследовано от Command) |
| Suggest(String) |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Symbol) |
Явные реализации интерфейса
| Имя. | Описание |
|---|---|
| ICommand.Argument |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| ICommand.Arguments |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| ICommand.Options |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Command) |
| IEnumerable.GetEnumerator() |
Возвращает перечислитель, который выполняет итерацию по коллекции. (Унаследовано от Command) |
| ISymbol.Children |
Представляет основное действие, которое выполняет приложение. (Унаследовано от Symbol) |
Методы расширения
| Имя. | Описание |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Представляет основное действие, которое выполняет приложение. |
| Invoke(Command, String, IConsole) |
Представляет основное действие, которое выполняет приложение. |
| Invoke(Command, String[], IConsole) |
Представляет основное действие, которое выполняет приложение. |
| InvokeAsync(Command, String, IConsole) |
Представляет основное действие, которое выполняет приложение. |
| InvokeAsync(Command, String[], IConsole) |
Представляет основное действие, которое выполняет приложение. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Представляет основное действие, которое выполняет приложение. |
| Parse(Command, String[]) |
Представляет основное действие, которое выполняет приложение. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Преобразует IEnumerable<T> в IAsyncEnumerable<T>. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Создает FrozenDictionary<TKey,TValue> из IEnumerable<T> в соответствии с указанными функциями селектора ключей и селектора элементов. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Создает из FrozenDictionary<TKey,TValue> указанной функции селектора ключей IEnumerable<T> . |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Создает объект FrozenSet<T> с указанными значениями. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Создает неизменяемый массив из указанной коллекции. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Перечисляет и преобразует последовательность и создает неизменяемый словарь его содержимого с помощью указанных средств сравнения ключей и значений. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Перечисляет и преобразует последовательность и создает неизменяемый словарь его содержимого с помощью указанного средства сравнения ключей. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Перечисляет и преобразует последовательность и создает неизменяемый словарь его содержимого. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Создает неизменяемый словарь на основе некоторого преобразования последовательности. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Создает неизменяемый словарь из существующей коллекции элементов, применяя функцию преобразования к исходным ключам. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Перечисляет последовательность, создает неизменяемый хэш-набор его содержимого и использует указанный средство сравнения равенства для типа набора. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Перечисляет последовательность и создает неизменяемый хэш-набор его содержимого. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Перечисляет последовательность и создает неизменяемый список его содержимого. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Перечисляет и преобразует последовательность и создает неизменяемый отсортированный словарь его содержимого с помощью указанных средств сравнения ключей и значений. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Перечисляет и преобразует последовательность и создает неизменяемый отсортированный словарь его содержимого с помощью указанного средства сравнения ключей. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Перечисляет и преобразует последовательность и создает неизменяемый отсортированный словарь его содержимого. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Перечисляет последовательность, создает неизменяемый отсортированный набор его содержимого и использует указанный сопоставитель. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Перечисляет последовательность и создает неизменяемый отсортированный набор его содержимого. |
| UseCommandHandler<THandler>(Command) |
Представляет основное действие, которое выполняет приложение. |
