RootCommand Класс

Определение

Пространство имен:

System.CommandLine

Сборка:

System.CommandLine.dll

Пакет:

System.CommandLine v3.0.0-preview.1.26104.118

Исходный код:

RootCommand.cs

Представляет основное действие, которое выполняет приложение.

public ref class RootCommand : System::CommandLine::Command

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Наследование

Object

Symbol

Command

RootCommand

Комментарии

Используйте объект RootCommand без вложенных команд для приложений, выполняющих одно действие. Добавьте вложенные команды в корневой каталог для приложений, требующих действий, определенных определенными строками. Например, "dir" не использует подкоманда. См Command . сведения о приложениях с несколькими действиями.

Конструкторы

Имя	Описание
RootCommand(String)	Представляет основное действие, которое выполняет приложение.

Свойства

Имя	Описание
Action	Возвращает или задает CommandLineAction для команды. Обработчик представляет действие, которое будет выполняться при вызове команды. (Унаследовано от Command)
Aliases	Возвращает уникальный набор строк, которые можно использовать в командной строке для указания команды. (Унаследовано от Command)
Arguments	Возвращает все аргументы для команды. (Унаследовано от Command)
Children	Возвращает дочерние символы. (Унаследовано от Command)
Description	Возвращает или задает описание символа. (Унаследовано от Symbol)
Directives	Представляет все директивы, допустимые в корневой команде.
ExecutableName	Имя выполняемого в настоящее время исполняемого файла.
ExecutablePath	Путь к исполняемому файлу, работающему в данный момент.
Hidden	Возвращает или задает значение, указывающее, скрыт ли символ. (Унаследовано от Symbol)
Name	Возвращает имя символа. (Унаследовано от Symbol)
Options	Возвращает все параметры для команды. (Унаследовано от Command)
Parents	Возвращает родительские символы. (Унаследовано от Symbol)
Subcommands	Возвращает все вложенные команды. (Унаследовано от Command)
TreatUnmatchedTokensAsErrors	Возвращает или задает значение, указывающее, следует ли рассматривать несоответствованные маркеры как ошибки. (Унаследовано от Command)
Validators	Возвращает проверяющие элементы в команду. Проверяющие элементы можно использовать для создания пользовательской логики проверки. (Унаследовано от Command)

Методы

Имя	Описание
Add(Argument)	Добавляет команду Argument . (Унаследовано от Command)
Add(Command)	Добавляет команду Command . (Унаследовано от Command)
Add(Directive)	Добавляет команду Directive .
Add(Option)	Добавляет команду Option . (Унаследовано от Command)
GetCompletions(CompletionContext)	Возвращает завершения для символа. (Унаследовано от Command)
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)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Symbol)

Явные реализации интерфейса

Имя	Описание
IEnumerable.GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по коллекции. (Унаследовано от Command)