Option Класс

Определение

Символ, определяющий именованный параметр и значение для этого параметра.

public ref class Option : System::CommandLine::IdentifierSymbol, System::CommandLine::Binding::IValueDescriptor
public class Option : System.CommandLine.IdentifierSymbol, System.CommandLine.Binding.IValueDescriptor
type Option = class
    inherit IdentifierSymbol
    interface IValueDescriptor
Public Class Option
Inherits IdentifierSymbol
Implements IValueDescriptor
Наследование
Производный
Реализации

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

Option(String, String, Type, Func<Object>, ArgumentArity)

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

Option(String[], String, Type, Func<Object>, ArgumentArity)

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

Свойства

Aliases

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

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

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

ArgumentHelpName

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

Arity

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

Description

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

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

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

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

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

Name

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

Parents

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

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

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

Методы

AddAlias(String)

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

(Унаследовано от IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)

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

Equals(Object)

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

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

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

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

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

GetHashCode()

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

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

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

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

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

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

Указывает, существует ли заданный псевдоним в параметре независимо от его префикса.

MemberwiseClone()

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

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

Задает значение по умолчанию для параметра .

SetDefaultValueFactory(Func<Object>)

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

ToString()

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

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

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

IValueDescriptor.GetDefaultValue()

Возвращает значение по умолчанию, если оно имеется.

IValueDescriptor.HasDefaultValue

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

IValueDescriptor.ValueName

Возвращает имя значения.

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

Parse(Option, String)

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

Parse(Option, String[])

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

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

См. также раздел