Class ParentedElementList

Namespace

MagicUI.Core

Assembly

MagicUI.dll

A list of arrangable elements with reference to hierarchical parents

public class ParentedElementList : IList<ArrangableElement>, ICollection<ArrangableElement>, IEnumerable<ArrangableElement>, IEnumerable

Inheritance

object

ParentedElementList

Implements

IList<ArrangableElement>

ICollection<ArrangableElement>

IEnumerable<ArrangableElement>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[int]

Gets or sets the element at the specified index.

public ArrangableElement this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

ArrangableElement

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The property is set and the IList<T> is read-only.

Methods

Add(ArrangableElement)

Adds an item to the ICollection<T>.

public void Add(ArrangableElement item)

Parameters

item ArrangableElement

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes and destroys all elements in the list.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(ArrangableElement)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(ArrangableElement item)

Parameters

item ArrangableElement

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(ArrangableElement[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(ArrangableElement[] array, int arrayIndex)

Parameters

array ArrangableElement[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<ArrangableElement> GetEnumerator()

Returns

IEnumerator<ArrangableElement>

An enumerator that can be used to iterate through the collection.

IndexOf(ArrangableElement)

Determines the index of a specific item in the IList<T>.

public int IndexOf(ArrangableElement item)

Parameters

item ArrangableElement

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, ArrangableElement)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, ArrangableElement item)

Parameters

index int

The zero-based index at which item should be inserted.

item ArrangableElement

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(ArrangableElement)

Removes and destroys the first occurrence of a specific element from the list.

public bool Remove(ArrangableElement item)

Parameters

item ArrangableElement

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes and destroys the element at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.