Command Класс

Определение

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

System.CommandLine

Сборка:

System.CommandLine.dll

Пакет:

System.CommandLine v3.0.0-preview.1.26104.118

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

Command.cs

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

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable

public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable

type Command = class
    inherit Symbol
    interface IEnumerable

Public Class Command
Inherits Symbol
Implements IEnumerable

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

Object

Symbol

Command

Производный

System.CommandLine.RootCommand

Реализации

IEnumerable

Комментарии

Используйте объект Command для действий, соответствующих определенной строке (имя команды). Для простых приложений, имеющих только одно действие, см. раздел RootCommand. Например, dotnet run используется run в качестве команды.

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

Имя	Описание
Command(String, String)	Инициализирует новый экземпляр класса Command.

Свойства

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

Методы

Имя	Описание
Add(Argument)	Добавляет команду Argument .
Add(Command)	Добавляет команду Command .
Add(Option)	Добавляет команду Option .
GetCompletions(CompletionContext)	Возвращает завершения для символа.
Parse(IReadOnlyList<String>, ParserConfiguration)	Анализирует строки массива с помощью команды.
Parse(String, ParserConfiguration)	Анализирует строковое значение командной строки с помощью команды.
SetAction(Action<ParseResult>)	Задает синхронное действие, выполняемое при вызове команды.
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	Задает асинхронное действие при вызове команды.
SetAction(Func<ParseResult,CancellationToken,Task>)	Задает асинхронное действие, выполняемое при вызове команды.
SetAction(Func<ParseResult,Int32>)	Задает синхронное действие, выполняемое при вызове команды.
SetAction(Func<ParseResult,Task<Int32>>)	Задает асинхронное действие, выполняемое при вызове команды.
SetAction(Func<ParseResult,Task>)	Задает асинхронное действие, выполняемое при вызове команды.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Symbol)

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

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