Class ParagraphStructBuilder

Namespace

Kook

Assembly

Kook.Net.Core.dll

用来构建 ParagraphStruct 元素的构建器。

public class ParagraphStructBuilder : IElementBuilder, IEquatable<ParagraphStructBuilder>, IEquatable<IElementBuilder>

Inheritance

object

ParagraphStructBuilder

Implements

IElementBuilder

IEquatable<ParagraphStructBuilder>

IEquatable<IElementBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ParagraphStructBuilder()

初始化一个 ParagraphStructBuilder 类的新实例。

public ParagraphStructBuilder()

ParagraphStructBuilder(int, IList<IElementBuilder>?)

初始化一个 ParagraphStructBuilder 类的新实例。

public ParagraphStructBuilder(int columnCount, IList<IElementBuilder>? fields = null)

Parameters

columnCount int

区域文本的列数。

fields IList<IElementBuilder>

区域文本的文本块。

Fields

MaxColumnCount

区域文本的最大列数。

public const int MaxColumnCount = 3

Field Value

int

MaxFieldCount

区域文本内文本块的最大数量。

public const int MaxFieldCount = 50

Field Value

int

MinColumnCount

区域文本的最小列数。

public const int MinColumnCount = 1

Field Value

int

Properties

ColumnCount

获取或设置区域文本的列数。

public int ColumnCount { get; set; }

Property Value

int

Remarks

默认值为 MinColumnCount。

Fields

获取或设置区域文本的文本块。

public IList<IElementBuilder> Fields { get; set; }

Property Value

IList<IElementBuilder>

Type

获取此构建器构建的元素的类型。

public ElementType Type { get; }

Property Value

ElementType

Methods

AddField(KMarkdownElementBuilder)

添加一个 KMarkdown 文本块到区域文本。

public ParagraphStructBuilder AddField(KMarkdownElementBuilder field)

Parameters

field KMarkdownElementBuilder

要添加的 KMarkdown 文本块。

Returns

ParagraphStructBuilder

当前构建器。

AddField(PlainTextElementBuilder)

添加一个纯文本文本块到区域文本。

public ParagraphStructBuilder AddField(PlainTextElementBuilder field)

Parameters

field PlainTextElementBuilder

要添加的纯文本文本块。

Returns

ParagraphStructBuilder

当前构建器。

AddField<T>(Action<T>?)

添加一个文本块到区域文本。

public ParagraphStructBuilder AddField<T>(Action<T>? action = null) where T : IElementBuilder, new()

Parameters

action Action<T>

用于创建一个 KMarkdownElement 的构建器的操作，该构建器将被添加到区域文本。

Returns

ParagraphStructBuilder

当前构建器。

Type Parameters

T

Build()

构建当前构建器为一个 ParagraphStruct。

public ParagraphStruct Build()

Returns

ParagraphStruct

由当前构建器表示的属性构建的 ParagraphStruct 对象。

Exceptions

ArgumentOutOfRangeException

ColumnCount 不足 MinColumnCount。

ArgumentOutOfRangeException

ColumnCount 超出了 MaxColumnCount。

ArgumentNullException

Fields 为 null。

ArgumentException

Fields 的数量超出了 MaxFieldCount。

ArgumentException

Fields 包含了既不是 PlainTextElementBuilder 也不是 KMarkdownElementBuilder 的元素。

Equals(ParagraphStructBuilder?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ParagraphStructBuilder? paragraphStructBuilder)

Parameters

paragraphStructBuilder ParagraphStructBuilder

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

WithColumnCount(int)

设置区域文本的列数。

public ParagraphStructBuilder WithColumnCount(int count)

Parameters

count int

区域文本的列数。

Returns

ParagraphStructBuilder

当前构建器。

Operators

operator ==(ParagraphStructBuilder?, ParagraphStructBuilder?)

判定两个 ParagraphStructBuilder 是否相等。

public static bool operator ==(ParagraphStructBuilder? left, ParagraphStructBuilder? right)

Parameters

left ParagraphStructBuilder

right ParagraphStructBuilder

Returns

bool

如果两个 ParagraphStructBuilder 相等，则为 true；否则为 false。

operator !=(ParagraphStructBuilder?, ParagraphStructBuilder?)

判定两个 ParagraphStructBuilder 是否不相等。

public static bool operator !=(ParagraphStructBuilder? left, ParagraphStructBuilder? right)

Parameters

left ParagraphStructBuilder

right ParagraphStructBuilder

Returns

bool

如果两个 ParagraphStructBuilder 不相等，则为 true；否则为 false。