Command Класс

Определение

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

public ref class Command : System::CommandLine::IdentifierSymbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>
public class Command : System.CommandLine.IdentifierSymbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>
type Command = class
    inherit IdentifierSymbol
    interface seq<Symbol>
    interface IEnumerable
Public Class Command
Inherits IdentifierSymbol
Implements IEnumerable(Of Symbol)
Наследование
Производный
Реализации

Комментарии

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

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

Command(String, String)

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

Свойства

Aliases

Возвращает набор строк, которые можно использовать в командной строке для указания символа.

(Унаследовано от IdentifierSymbol)
Arguments

Представляет все аргументы для команды.

Children

Возвращает дочерние символы.

Description

Возвращает или задает описание символа.

(Унаследовано от Symbol)
Handler

Возвращает или задает ICommandHandler для команды . Обработчик представляет действие, которое будет выполняться при вызове команды.

IsHidden

Возвращает или задает значение, указывающее, скрыт ли символ.

(Унаследовано от Symbol)
Name

Возвращает или задает имя символа.

(Унаследовано от IdentifierSymbol)
Options

Представляет все параметры команды, включая глобальные параметры, которые были применены к любому из предков команды.

Parents

Возвращает родительские символы.

(Унаследовано от Symbol)
Subcommands

Представляет все подкоманды для команды.

TreatUnmatchedTokensAsErrors

Возвращает или задает значение, указывающее, следует ли рассматривать несовпадающие маркеры как ошибки. Например, если задано значение true и указана дополнительная команда или аргумент, проверка завершится ошибкой.

Методы

Add(Argument)

Добавляет в Argument команду .

Add(Command)

Добавляет в команду подкоманду.

Add(Option)

Добавляет в Option команду .

AddAlias(String)

Добавляет псевдоним.

(Унаследовано от IdentifierSymbol)
AddArgument(Argument)

Добавляет в Argument команду .

AddCommand(Command)

Добавляет в команду подкоманду.

AddGlobalOption(Option)

Добавляет глобальный Option объект в команду .

AddOption(Option)

Добавляет в Option команду .

AddValidator(ValidateSymbolResult<CommandResult>)

Добавляет в команду пользовательский проверяющий элемент управления. Проверяющие элементы можно использовать для создания пользовательской логики проверки.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetCompletions()

Возвращает завершения для символа.

(Унаследовано от Symbol)
GetCompletions(CompletionContext)

Возвращает предлагаемые значения для завершения командной строки.

GetEnumerator()

Возвращает перечислитель, представляющий все символы для команды.

GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
HasAlias(String)

Определяет, определен ли псевдоним.

(Унаследовано от IdentifierSymbol)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Symbol)

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

IEnumerable.GetEnumerator()

Возвращает перечислитель, который осуществляет итерацию по коллекции.

Методы расширения

Invoke(Command, String, IConsole)

Анализирует и вызывает команду.

Invoke(Command, String[], IConsole)

Анализирует и вызывает команду.

InvokeAsync(Command, String, IConsole)

Анализирует и вызывает команду.

InvokeAsync(Command, String[], IConsole)

Анализирует и вызывает команду.

Parse(Command, String)

Анализирует значение строки командной строки с помощью указанной команды.

Parse(Command, String[])

Анализирует строки массива с помощью указанной команды.

SetHandler(Command, Action)

Задает обработчик команды на Actionоснове .

SetHandler(Command, Func<Task>)

Задает обработчик команды на Func<TResult>основе .

SetHandler<T>(Command, Action<T>, IValueDescriptor[])

Задает обработчик команды на Action<T>основе .

SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>основе .

SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2>основе .

SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,TResult>основе .

SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3>основе .

SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,TResult>основе .

SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4>основе .

SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,TResult>основе .

SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5>основе .

SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6>основе .

SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])

Задает обработчик команды на Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>основе .

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])

Задает обработчик команды на Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>основе .

Применяется к