Class ImageNodeBuilder

Namespace

HeyBox

Assembly

HeyBox.Net.Core.dll

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

public class ImageNodeBuilder : INodeBuilder, IEquatable<ImageNodeBuilder>, IEquatable<INodeBuilder>

Inheritance

object

ImageNodeBuilder

Implements

INodeBuilder

IEquatable<ImageNodeBuilder>

IEquatable<INodeBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ImageNodeBuilder()

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

public ImageNodeBuilder()

ImageNodeBuilder(string, ImageSize?, NodeWidth?)

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

public ImageNodeBuilder(string url, ImageSize? size = null, NodeWidth? width = null)

Parameters

url string

图片的源。

size ImageSize?

图片的大小。

width NodeWidth?

节点的宽度。

Remarks

size 仅在 SectionModuleBuilder 中生效且必需，ImagesModuleBuilder 中不生效。

Properties

Size

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

public ImageSize? Size { get; set; }

Property Value

ImageSize?

Remarks

当前属性仅在 SectionModuleBuilder 中生效且必需，ImagesModuleBuilder 中不生效。

Type

获取此构建器构建的节点的类型。

public NodeType Type { get; }

Property Value

NodeType

Url

获取或设置图片的源。

public string? Url { get; set; }

Property Value

string

Remarks

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

Width

获取或设置此构建器构建的节点的大小。

public NodeWidth? Width { get; set; }

Property Value

NodeWidth?

Methods

Build()

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

public ImageNode Build()

Returns

ImageNode

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

Exceptions

ArgumentNullException

Url 为 null。

ArgumentException

Url 为空字符串。

UriFormatException

Url 不是有效的 URL。

Equals(ImageNodeBuilder?)

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

public bool Equals(ImageNodeBuilder? imageNodeBuilder)

Parameters

imageNodeBuilder ImageNodeBuilder

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.

WithSize(ImageSize?)

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

public ImageNodeBuilder WithSize(ImageSize? size)

Parameters

size ImageSize?

图片的大小。

Returns

ImageNodeBuilder

当前构建器。

Remarks

图片的尺寸仅在 SectionModuleBuilder 中生效且必需，ImagesModuleBuilder 中不生效。

WithUrl(string?)

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

public ImageNodeBuilder WithUrl(string? url)

Parameters

url string

图片的源。

Returns

ImageNodeBuilder

当前构建器。

Remarks

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

WithWidth(NodeWidth)

设置节点的宽度，值将被设置到 Width 属性上。

public ImageNodeBuilder WithWidth(NodeWidth width)

Parameters

width NodeWidth

节点的宽度。

Returns

ImageNodeBuilder

当前构建器。

Operators

operator ==(ImageNodeBuilder?, ImageNodeBuilder?)

判定两个 ImageNodeBuilder 是否相等。

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

Parameters

left ImageNodeBuilder

right ImageNodeBuilder

Returns

bool

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

implicit operator ImageNodeBuilder(string)

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

public static implicit operator ImageNodeBuilder(string source)

Parameters

source string

图片的源。

Returns

ImageNodeBuilder

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

operator !=(ImageNodeBuilder?, ImageNodeBuilder?)

判定两个 ImageNodeBuilder 是否不相等。

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

Parameters

left ImageNodeBuilder

right ImageNodeBuilder

Returns

bool

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