Class ItemIndexCollection

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents a collection of item indexes.

public class ItemIndexCollection : Collection<ItemIndex>, IList<ItemIndex>, ICollection<ItemIndex>, IList, ICollection, IReadOnlyList<ItemIndex>, IReadOnlyCollection<ItemIndex>, IEnumerable<ItemIndex>, IEnumerable

Inheritance

object

Collection<ItemIndex>

ItemIndexCollection

Implements

IList<ItemIndex>

ICollection<ItemIndex>

IList

ICollection

IReadOnlyList<ItemIndex>

IReadOnlyCollection<ItemIndex>

IEnumerable<ItemIndex>

IEnumerable

Inherited Members

Collection<ItemIndex>.Add(ItemIndex)

Collection<ItemIndex>.Clear()

Collection<ItemIndex>.CopyTo(ItemIndex[], int)

Collection<ItemIndex>.Contains(ItemIndex)

Collection<ItemIndex>.GetEnumerator()

Collection<ItemIndex>.IndexOf(ItemIndex)

Collection<ItemIndex>.Insert(int, ItemIndex)

Collection<ItemIndex>.Remove(ItemIndex)

Collection<ItemIndex>.RemoveAt(int)

Collection<ItemIndex>.ClearItems()

Collection<ItemIndex>.RemoveItem(int)

Collection<ItemIndex>.SetItem(int, ItemIndex)

Collection<ItemIndex>.Count

Collection<ItemIndex>.Items

Collection<ItemIndex>.this[int]

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ItemIndexCollection()

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

public ItemIndexCollection()

Methods

Add(ItemIndexType, string)

Adds a new item index to the collection with the specified index type and value.

public ItemIndex Add(ItemIndexType indexType, string value)

Parameters

indexType ItemIndexType

The index type.

value string

The value.

Returns

ItemIndex

The item index that was added to the collection.

Add(ItemIndexType, string, ItemIndexComponentType, string, Guid)

Adds a new item index to the collection with the specified index type and value.

public ItemIndex Add(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.

Returns

ItemIndex

The item index that was added to the collection.

Exists(ItemIndexType)

Returns a System.Boolean value that indicates whether any item indexes of the specified index type exist within the collection.

public bool Exists(ItemIndexType indexType)

Parameters

indexType ItemIndexType

The index type of the item indexes to return.

Returns

bool

A System.Boolean value that indicates whether any item indexes of the specified index type exist within the collection.

Exists(ItemIndexType, Guid)

Returns a System.Boolean value that indicates whether any item indexes of the specified index type exist within the collection.

public bool Exists(ItemIndexType indexType, Guid componentIdentifier)

Parameters

indexType ItemIndexType

The index type of the item indexes to return.

componentIdentifier Guid

The optional component identifier.

Returns

bool

A System.Boolean value that indicates whether any item indexes of the specified index type exist within the collection.

Exists(ItemIndexType, string)

Returns a System.Boolean value that indicates whether a CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria exists within the collection.

public bool Exists(ItemIndexType indexType, string value)

Parameters

indexType ItemIndexType

The index type of the item index to return.

value string

The index value.

Returns

bool

A System.Boolean value that indicates whether a CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria exists within the collection.

Exists(ItemIndexType, string, ItemIndexComponentType, string, Guid)

Returns a System.Boolean value that indicates whether a CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria exists within the collection.

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

Parameters

indexType ItemIndexType

The index type of the item index to return.

value string

The index value.

componentType ItemIndexComponentType

The component type.

componentDisplayName string

The optional component display name.

componentIdentifier Guid

The optional component identifier.

Returns

bool

A System.Boolean value that indicates whether a CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria exists within the collection.

Find(ItemIndexType, string)

Returns the CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria, or null if no item index matches the criteria.

public ItemIndex Find(ItemIndexType indexType, string value)

Parameters

indexType ItemIndexType

The index type of the item index to return.

value string

The index value.

Returns

ItemIndex

The CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria, or null if no item index matches the criteria.

Find(ItemIndexType, string, ItemIndexComponentType, string, Guid)

Returns the CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria, or null if no item index matches the criteria.

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

Parameters

indexType ItemIndexType

The index type of the item index to return.

value string

The index value.

componentType ItemIndexComponentType

The component type.

componentDisplayName string

The optional component display name.

componentIdentifier Guid

The optional component identifier.

Returns

ItemIndex

The CENTREL.XIA.Configuration.Types.ItemIndex that matches the specified criteria, or null if no item index matches the criteria.

FindByIndexType(ItemIndexType)

Returns a CENTREL.XIA.Configuration.Types.ItemIndexCollection containing the item indexes of the specified index type.

public ItemIndexCollection FindByIndexType(ItemIndexType indexType)

Parameters

indexType ItemIndexType

The index type of the item indexes to return.

Returns

ItemIndexCollection

A CENTREL.XIA.Configuration.Types.ItemIndexCollection containing the item indexes of the specified index type.

FindByIndexType(ItemIndexType, Guid)

Returns a CENTREL.XIA.Configuration.Types.ItemIndexCollection containing the item indexes of the specified index type.

public ItemIndexCollection FindByIndexType(ItemIndexType indexType, Guid componentIdentifier)

Parameters

indexType ItemIndexType

The index type of the item indexes to return.

componentIdentifier Guid

The optional component identifier.

Returns

ItemIndexCollection

A CENTREL.XIA.Configuration.Types.ItemIndexCollection containing the item indexes of the specified index type.

InsertItem(int, ItemIndex)

Occurs when an item index is inserted into the collection.

protected override void InsertItem(int index, ItemIndex item)

Parameters

index int

The index at which the item is to be inserted.

item ItemIndex

The item to insert.

Sort()

Sorts the values in the collection.

public void Sort()