Class HeaderModuleBuilder

Namespace

HeyBox

Assembly

HeyBox.Net.Core.dll

用来构建 HeaderModule 模块的构建器。

public class HeaderModuleBuilder : IModuleBuilder, IEquatable<HeaderModuleBuilder>, IEquatable<IModuleBuilder>

Inheritance

object

HeaderModuleBuilder

Implements

IModuleBuilder

IEquatable<HeaderModuleBuilder>

IEquatable<IModuleBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

HeaderModuleBuilder()

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

public HeaderModuleBuilder()

HeaderModuleBuilder(ITextNodeBuilder)

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

public HeaderModuleBuilder(ITextNodeBuilder content)

Parameters

content ITextNodeBuilder

标题内容。

HeaderModuleBuilder(string, bool)

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

public HeaderModuleBuilder(string text, bool isMarkdown = false)

Parameters

text string

标题内容的文本。

isMarkdown bool

是否为 Markdown 格式。

Fields

MaxHeaderContentLength

标题内容内容的最大长度。

public const int MaxHeaderContentLength = 100

Field Value

int

Properties

Content

获取或设置标题内容。

public ITextNodeBuilder? Content { get; set; }

Property Value

ITextNodeBuilder

Type

获取此构建器构建的模块的类型。

public ModuleType Type { get; }

Property Value

ModuleType

Methods

Build()

构建当前构建器为一个 HeaderModule 对象。

public HeaderModule Build()

Returns

HeaderModule

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

Exceptions

ArgumentNullException

Content 为 null。

ArgumentException

Content 的内容为 null。

ArgumentException

Content 的内容长度超过了 MaxHeaderContentLength。

Equals(HeaderModuleBuilder?)

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

public bool Equals(HeaderModuleBuilder? headerModuleBuilder)

Parameters

headerModuleBuilder HeaderModuleBuilder

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.

WithContent(ITextNodeBuilder)

设置标题内容。

public HeaderModuleBuilder WithContent(ITextNodeBuilder content)

Parameters

content ITextNodeBuilder

要设置的标题内容。

Returns

HeaderModuleBuilder

当前构建器。

WithContent(string, bool)

设置标题内容。

public HeaderModuleBuilder WithContent(string content, bool isMarkdown = false)

Parameters

content string

要设置的标题内容。

isMarkdown bool

是否为 Markdown 格式。

Returns

HeaderModuleBuilder

当前构建器。

WithContent<T>(Action<T>?)

设置标题内容。

public HeaderModuleBuilder WithContent<T>(Action<T>? action = null) where T : ITextNodeBuilder, new()

Parameters

action Action<T>

一个包含对要设置的标题内容进行配置的操作的委托。

Returns

HeaderModuleBuilder

当前构建器。

Type Parameters

T

Operators

operator ==(HeaderModuleBuilder?, HeaderModuleBuilder?)

判定两个 HeaderModuleBuilder 是否相等。

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

Parameters

left HeaderModuleBuilder

right HeaderModuleBuilder

Returns

bool

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

implicit operator HeaderModuleBuilder(string)

使用指定的纯内容内容内容初始化一个新的 HeaderModuleBuilder 类的实例。

public static implicit operator HeaderModuleBuilder(string text)

Parameters

text string

纯内容内容内容。

Returns

HeaderModuleBuilder

一个使用指定的纯内容内容内容初始化的 PlainTextNodeBuilder 类的实例。

operator !=(HeaderModuleBuilder?, HeaderModuleBuilder?)

判定两个 HeaderModuleBuilder 是否不相等。

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

Parameters

left HeaderModuleBuilder

right HeaderModuleBuilder

Returns

bool

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