Class ItemIndex

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents an item index.

public class ItemIndex : GlobalSerializableBase, IComparable<ItemIndex>

Inheritance

object

ItemIndex

Implements

IComparable<ItemIndex>

Constructors

ItemIndex()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.ItemIndex class.

public ItemIndex()

ItemIndex(ItemIndexType, string)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.ItemIndex class.

public ItemIndex(ItemIndexType indexType, string value)

Parameters

indexType ItemIndexType

The index type.

value string

The value.

ItemIndex(ItemIndexType, string, ItemIndexComponentType, string, Guid)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.ItemIndex class.

public ItemIndex(ItemIndexType indexType, string value, ItemIndexComponentType componentType, string componentDisplayName, Guid componentIdentifier)

Parameters

indexType ItemIndexType

The index type.

value string

The value.

componentType ItemIndexComponentType

The optional component type.

componentDisplayName string

The optional component display name.

componentIdentifier Guid

The optional component identifier.

Properties

ComponentDisplayName

Gets or sets the optional component display name.

public string ComponentDisplayName { get; set; }

Property Value

string

ComponentIdentifier

Gets or sets the optional component identifier.

public Guid ComponentIdentifier { get; set; }

Property Value

Guid

ComponentType

Gets or sets the optional index component type.

public ItemIndexComponentType ComponentType { get; set; }

Property Value

ItemIndexComponentType

ComponentTypeDisplayName

Gets the display name of the component type.

public string ComponentTypeDisplayName { get; }

Property Value

string

IndexType

Gets or sets the index type.

public ItemIndexType IndexType { get; set; }

Property Value

ItemIndexType

IndexTypeDisplayName

Gets the display name of the index type.

public string IndexTypeDisplayName { get; }

Property Value

string

IsUnique

Gets whether the item index is a unique value.

public bool IsUnique { get; }

Property Value

bool

Value

Gets or sets the value of the index.

public string Value { get; set; }

Property Value

string

Methods

CompareTo(ItemIndex)

Compares two CENTREL.XIA.Configuration.Types.ItemIndex objects to allow sorting by index type and values.

public int CompareTo(ItemIndex other)

Parameters

other ItemIndex

The CENTREL.XIA.Configuration.Types.ItemIndex to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.ItemIndex objects.

ShouldSerializeComponentDisplayName()

Determines whether the component display name property should be serialized.

public bool ShouldSerializeComponentDisplayName()

Returns

bool

A System.Boolean value that indicates whether the component display name property should be serialized.

ShouldSerializeComponentIdentifier()

Determines whether the component identifier property should be serialized.

public bool ShouldSerializeComponentIdentifier()

Returns

bool

A System.Boolean value that indicates whether the component identifier property should be serialized.

ShouldSerializeComponentType()

Determines whether the component type property should be serialized.

public bool ShouldSerializeComponentType()

Returns

bool

A System.Boolean value that indicates whether the component type property should be serialized.

ToString()

Returns the item index in a human readable format.

public override string ToString()

Returns

string

The item index in a human readable format.