Class ElementCollection
- Namespace
- PluginUI
- Assembly
- PluginUI.dll
Children collection of a Panel: maintains parent links, host attachment and layout invalidation.
public sealed class ElementCollection : IList<UIElement>, ICollection<UIElement>, IReadOnlyList<UIElement>, IReadOnlyCollection<UIElement>, IEnumerable<UIElement>, IEnumerable
- Inheritance
-
ElementCollection
- Implements
- Inherited Members
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 UIElement this[int index] { get; set; }
Parameters
indexintThe zero-based index of the element to get or set.
Property Value
- UIElement
The element at the specified index.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The property is set and the IList<T> is read-only.
Methods
Add(UIElement)
Adds an item to the ICollection<T>.
public void Add(UIElement item)
Parameters
itemUIElementThe object to add to the ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
BringToFront(UIElement)
Moves a child to the end (drawn on top).
public void BringToFront(UIElement item)
Parameters
itemUIElement
Clear()
Removes all items from the ICollection<T>.
public void Clear()
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
Contains(UIElement)
Determines whether the ICollection<T> contains a specific value.
public bool Contains(UIElement item)
Parameters
itemUIElementThe object to locate in the ICollection<T>.
Returns
- bool
true if
itemis found in the ICollection<T>; otherwise, false.
CopyTo(UIElement[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
public void CopyTo(UIElement[] array, int arrayIndex)
Parameters
arrayUIElement[]The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
arrayIndexintThe zero-based index in
arrayat which copying begins.
Exceptions
- ArgumentNullException
arrayis null.- ArgumentOutOfRangeException
arrayIndexis less than 0.- ArgumentException
The number of elements in the source ICollection<T> is greater than the available space from
arrayIndexto the end of the destinationarray.
GetEnumerator()
Returns an enumerator that iterates through the collection.
public IEnumerator<UIElement> GetEnumerator()
Returns
- IEnumerator<UIElement>
An enumerator that can be used to iterate through the collection.
IndexOf(UIElement)
Determines the index of a specific item in the IList<T>.
public int IndexOf(UIElement item)
Parameters
Returns
- int
The index of
itemif found in the list; otherwise, -1.
Insert(int, UIElement)
Inserts an item to the IList<T> at the specified index.
public void Insert(int index, UIElement item)
Parameters
indexintThe zero-based index at which
itemshould be inserted.itemUIElementThe object to insert into the IList<T>.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.
Remove(UIElement)
Removes the first occurrence of a specific object from the ICollection<T>.
public bool Remove(UIElement item)
Parameters
itemUIElementThe object to remove from the ICollection<T>.
Returns
- bool
true if
itemwas successfully removed from the ICollection<T>; otherwise, false. This method also returns false ifitemis not found in the original ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
RemoveAt(int)
Removes the IList<T> item at the specified index.
public void RemoveAt(int index)
Parameters
indexintThe zero-based index of the item to remove.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.