Interface IParameterBuilder

Namespace

HeyBox.Interactions.Builders

Assembly

HeyBox.Net.Interactions.dll

表示用于创建 IParameterInfo 的命令参数生成器。

public interface IParameterBuilder

Properties

Attributes

获取此命令的特性集合。

IReadOnlyCollection<Attribute> Attributes { get; }

Property Value

IReadOnlyCollection<Attribute>

Command

获取此参数所属的父命令。

ICommandBuilder Command { get; }

Property Value

ICommandBuilder

DefaultValue

获取此参数的默认值。

object? DefaultValue { get; }

Property Value

object

IsParameterArray

获取此参数是否为 params。

bool IsParameterArray { get; }

Property Value

bool

IsRequired

获取此参数是否为必填项。

bool IsRequired { get; }

Property Value

bool

Name

获取此参数的名称。

string? Name { get; }

Property Value

string

ParameterType

获取此参数的类型。

Type? ParameterType { get; }

Property Value

Type

Preconditions

获取此命令的先决条件集合。

IReadOnlyCollection<ParameterPreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyCollection<ParameterPreconditionAttribute>

Methods

AddAttributes(params Attribute[])

向 Attributes 添加特性。

IParameterBuilder AddAttributes(params Attribute[] attributes)

Parameters

attributes Attribute[]

要添加到 Attributes 的新特性。

Returns

IParameterBuilder

生成器实例。

AddPreconditions(params ParameterPreconditionAttribute[])

向 Preconditions 添加先决条件。

IParameterBuilder AddPreconditions(params ParameterPreconditionAttribute[] preconditions)

Parameters

preconditions ParameterPreconditionAttribute[]

要添加到 Preconditions 的新先决条件。

Returns

IParameterBuilder

生成器实例。

SetDefaultValue(object)

设置 DefaultValue。

IParameterBuilder SetDefaultValue(object defaultValue)

Parameters

defaultValue object

DefaultValue 的新值。

Returns

IParameterBuilder

生成器实例。

SetParameterType(Type)

设置 ParameterType。

IParameterBuilder SetParameterType(Type type)

Parameters

type Type

ParameterType 的新值。

Returns

IParameterBuilder

生成器实例。

SetRequired(bool)

设置 IsRequired。

IParameterBuilder SetRequired(bool isRequired)

Parameters

isRequired bool

IsRequired 的新值。

Returns

IParameterBuilder

生成器实例。

WithName(string)

设置 Name。

IParameterBuilder WithName(string name)

Parameters

name string

Name 的新值。

Returns

IParameterBuilder

生成器实例。