Class ImageElementBuilder

Namespace

Kook

Assembly

Kook.Net.Core.dll

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

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

Inheritance

object

ImageElementBuilder

Implements

IElementBuilder

IEquatable<ImageElementBuilder>

IEquatable<IElementBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ImageElementBuilder()

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

public ImageElementBuilder()

ImageElementBuilder(string, string?, ImageSize?, bool)

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

public ImageElementBuilder(string source, string? alternative = null, ImageSize? size = null, bool circle = false)

Parameters

source string

图片的源。

alternative string

图片的替代文本。

size ImageSize?

图片的大小。

circle bool

图片是否应渲染为圆形。

Remarks

size 仅在 ContextModuleBuilder 中生效，ContainerModuleBuilder 中不生效。

Fields

MaxAlternativeLength

图片替代文本的最大长度。

public const int MaxAlternativeLength = 20

Field Value

int

Properties

Alternative

获取或设置图片的替代文本。

public string? Alternative { get; set; }

Property Value

string

Circle

获取或设置图片是否应渲染为圆形。

public bool? Circle { get; set; }

Property Value

bool?

Size

获取或设置 ImageElementBuilder 的图片大小。

public ImageSize? Size { get; set; }

Property Value

ImageSize?

Remarks

当前属性仅在 ContextModuleBuilder 中生效，ContainerModuleBuilder 中不生效。

Source

获取或设置图片的源。

public string? Source { get; set; }

Property Value

string

Remarks

图片的媒体类型仅支持 image/jpeg、image/gif、image/png。

Type

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

public ElementType Type { get; }

Property Value

ElementType

Methods

Build()

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

public ImageElement Build()

Returns

ImageElement

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

Exceptions

ArgumentNullException

Source 为 null。

ArgumentException

Source 为空字符串。

UriFormatException

Source 不是有效的 URL。

ArgumentException

Alternative 的长度超过了 MaxAlternativeLength。

Equals(ImageElementBuilder?)

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

public bool Equals(ImageElementBuilder? imageElementBuilder)

Parameters

imageElementBuilder ImageElementBuilder

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.

WithAlternative(string?)

设置图片的替代文本，值将被设置到 Alternative 属性上。

public ImageElementBuilder WithAlternative(string? alternative)

Parameters

alternative string

图片的替代文本。

Returns

ImageElementBuilder

当前构建器。

WithCircle(bool?)

设置图片是否应渲染为圆形，值将被设置到 Circle 属性上。

public ImageElementBuilder WithCircle(bool? circle)

Parameters

circle bool?

图片是否应渲染为圆形。

Returns

ImageElementBuilder

当前构建器。

WithSize(ImageSize?)

设置图片的大小，值将被设置到 Size 属性上。

public ImageElementBuilder WithSize(ImageSize? size)

Parameters

size ImageSize?

图片的大小。

Returns

ImageElementBuilder

当前构建器。

WithSource(string?)

设置图片的源，值将被设置到 Source 属性上。

public ImageElementBuilder WithSource(string? source)

Parameters

source string

图片的源。

Returns

ImageElementBuilder

当前构建器。

Remarks

图片的媒体类型仅支持 image/jpeg、image/gif、image/png。

Operators

operator ==(ImageElementBuilder?, ImageElementBuilder?)

判定两个 ImageElementBuilder 是否相等。

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

Parameters

left ImageElementBuilder

right ImageElementBuilder

Returns

bool

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

implicit operator ImageElementBuilder(string)

使用指定的图片源初始化一个新的 ImageElementBuilder 类的实例。

public static implicit operator ImageElementBuilder(string source)

Parameters

source string

图片的源。

Returns

ImageElementBuilder

一个使用指定的图片源初始化的 ImageElementBuilder 类的实例。

operator !=(ImageElementBuilder?, ImageElementBuilder?)

判定两个 ImageElementBuilder 是否不相等。

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

Parameters

left ImageElementBuilder

right ImageElementBuilder

Returns

bool

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