Class ImageGroupModuleBuilder

Namespace

Kook

Assembly

Kook.Net.Core.dll

Representing an image group module builder for create an ImageGroupModule.

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

Inheritance

object

ImageGroupModuleBuilder

Implements

IModuleBuilder

IEquatable<ImageGroupModuleBuilder>

IEquatable<IModuleBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ImageGroupModuleBuilder()

Initializes a new instance of the ImageGroupModuleBuilder class.

public ImageGroupModuleBuilder()

ImageGroupModuleBuilder(IList<ImageElementBuilder>)

Initializes a new instance of the ImageGroupModuleBuilder class.

public ImageGroupModuleBuilder(IList<ImageElementBuilder> elements)

Parameters

elements IList<ImageElementBuilder>

Fields

MaxElementCount

Returns the maximum number of elements allowed by Kook.

public const int MaxElementCount = 9

Field Value

int

Properties

Elements

Gets or sets the elements of the image group.

public IList<ImageElementBuilder> Elements { get; set; }

Property Value

IList<ImageElementBuilder>

An ImageElementBuilder containing the elements of the image group.

Exceptions

ArgumentException

The addition operation would cause the number of elements to exceed MaxElementCount.

Type

Specifies the module type of the IModule this builder creates.

public ModuleType Type { get; }

Property Value

ModuleType

A ModuleType representing the module type of the IModule this builder creates.

Methods

AddElement(ImageElementBuilder)

Adds an image element to the image group.

public ImageGroupModuleBuilder AddElement(ImageElementBuilder field)

Parameters

field ImageElementBuilder

The image element to add.

Returns

ImageGroupModuleBuilder

The current builder.

Exceptions

ArgumentException

The addition operation would cause the number of elements to exceed MaxElementCount.

AddElement(Action<ImageElementBuilder>)

Adds an image element to the image group.

public ImageGroupModuleBuilder AddElement(Action<ImageElementBuilder> action)

Parameters

action Action<ImageElementBuilder>

The action to add an image element to the image group.

Returns

ImageGroupModuleBuilder

The current builder.

Exceptions

ArgumentException

The addition operation would cause the number of elements to exceed MaxElementCount.

Build()

Builds this builder into an ImageGroupModule.

public ImageGroupModule Build()

Returns

ImageGroupModule

An ImageGroupModule representing the built image group module object.

Exceptions

ArgumentNullException

The Elements is null.

ArgumentException

The Elements is an empty list.

ArgumentException

Element count is greater than MaxElementCount.

Equals(ImageGroupModuleBuilder?)

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

public bool Equals(ImageGroupModuleBuilder? imageGroupModuleBuilder)

Parameters

imageGroupModuleBuilder ImageGroupModuleBuilder

The ImageGroupModuleBuilder to compare with the current ImageGroupModuleBuilder.

Returns

bool

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

Equals(object?)

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

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current ImageGroupModuleBuilder.

Returns

bool

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

Remarks

If the object passes is an ImageGroupModuleBuilder, Equals(ImageGroupModuleBuilder?) will be called to compare the 2 instances.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Operators

operator ==(ImageGroupModuleBuilder?, ImageGroupModuleBuilder?)

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

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

Parameters

left ImageGroupModuleBuilder

right ImageGroupModuleBuilder

Returns

bool

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

operator !=(ImageGroupModuleBuilder?, ImageGroupModuleBuilder?)

Determines whether the specified ImageGroupModuleBuilder is not equal to the current ImageGroupModuleBuilder.

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

Parameters

left ImageGroupModuleBuilder

right ImageGroupModuleBuilder

Returns

bool

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