Class
SpecializedDocumentElementCollection<TInheritor>

Represents a collection of specialized document elements of type TInheritor.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Type Parameters:

TInheritor

The type of the elements in the collection.

Syntax:

cs-api-definition
public abstract class SpecializedDocumentElementCollection<TInheritor> : ICollection<TInheritor>, IEnumerable<TInheritor>, IList, ICollection, IEnumerable where TInheritor : DocumentElement

Inheritance: objectSpecializedDocumentElementCollection<TInheritor>

Derived Classes: BlockCollectionInlineCollectionParagraphCollectionSectionCollectionTableCellCollectionTableRowCollection

Implements: ICollectionICollection<TInheritor>IEnumerableIEnumerable<TInheritor>IList

Properties

Count

Gets the number of elements contained in the collection.

Declaration

cs-api-definition
public int Count { get; }

Property Value

int

Implements ICollection<TInheritor>.Count

First

Gets the first element in the collection of specialized document elements.

Declaration

cs-api-definition
public TInheritor First { get; }

Property Value

TInheritor

InnerCollection

Declaration

cs-api-definition
protected DocumentElementCollection InnerCollection { get; }

Property Value

DocumentElementCollection

IsReadOnly

Gets a value indicating whether the collection is read-only.

Declaration

cs-api-definition
public bool IsReadOnly { get; }

Property Value

bool

Implements ICollection<TInheritor>.IsReadOnly

Last

Gets the last element in the collection of specialized document elements.

Declaration

cs-api-definition
public TInheritor Last { get; }

Property Value

TInheritor

Methods

Add(TInheritor)

Adds a DocumentElement to the collection.

Declaration

cs-api-definition
public void Add(TInheritor item)

Parameters

item

TInheritor

The object to add to the ICollection<T>.

Implements ICollection<TInheritor>.Add(TInheritor)

AddAfter(TInheritor, TInheritor)

Adds a new element of type TInheritor after a specified existing element in the collection.

Declaration

cs-api-definition
public void AddAfter(TInheritor item, TInheritor newItem)

Parameters

item

TInheritor

The element after which the new element will be added.

newItem

TInheritor

The new element to be added to the collection.

AddBefore(TInheritor, TInheritor)

Adds a new element before a specified existing element in the collection.

Declaration

cs-api-definition
public void AddBefore(TInheritor item, TInheritor newItem)

Parameters

item

TInheritor

The new element to be added to the collection.

newItem

TInheritor

The existing element before which the new element will be inserted.

AddRange(IEnumerable<TInheritor>)

Adds a collection of elements to the specialized document element collection.

Declaration

cs-api-definition
public void AddRange(IEnumerable<TInheritor> range)

Parameters

range

IEnumerable<TInheritor>

The collection of elements to add to the collection.

Clear()

Clears all elements from the collection.

Declaration

cs-api-definition
public void Clear()

Implements ICollection<TInheritor>.Clear()

Remarks

This method removes all items from the current collection, resetting it to an empty state.

Contains(TInheritor)

Determines whether the collection contains a specific element.

Declaration

cs-api-definition
public bool Contains(TInheritor item)

Parameters

item

TInheritor

The element to locate in the collection.

Returns

bool

true if the collection contains the element; otherwise, false.

Implements ICollection<TInheritor>.Contains(TInheritor)

CopyTo(TInheritor[], int)

Copies the elements of the collection to a specified array, starting at a particular index.

Declaration

cs-api-definition
public void CopyTo(TInheritor[] array, int arrayIndex)

Parameters

array

TInheritor[]

The one-dimensional array that is the destination of the elements copied from the collection. The array must have a zero-based index.

arrayIndex

int

The zero-based index in the destination array at which storing the copied elements will begin.

Implements ICollection<TInheritor>.CopyTo(TInheritor[], int)

Detach(TInheritor)

Detaches the specified element from the collection.

Declaration

cs-api-definition
public bool Detach(TInheritor item)

Parameters

item

TInheritor

The element to be detached from the collection.

Returns

bool

Returns the detached element.

GetEnumerator()

Returns an enumerator that iterates through the collection of specialized document elements.

Declaration

cs-api-definition
public IEnumerator<TInheritor> GetEnumerator()

Returns

IEnumerator<TInheritor>

A enumerator that provides iteration over the current collection of specialized document elements.

Implements IEnumerable<TInheritor>.GetEnumerator()

OnCollectionChanged()

Called when the collection is changed. Raises CollectionChanged event.

Declaration

cs-api-definition
protected virtual void OnCollectionChanged()

OnElementAdded(DocumentElement)

Called when DocumentElement is added.

Declaration

cs-api-definition
protected virtual void OnElementAdded(DocumentElement element)

Parameters

element

DocumentElement

The element.

Remove(TInheritor)

Removes the specified element from the collection.

Declaration

cs-api-definition
public bool Remove(TInheritor item)

Parameters

item

TInheritor

The element to be removed from the collection.

Returns

bool

True if the element was successfully removed; otherwise, false.

Implements ICollection<TInheritor>.Remove(TInheritor)

ToArray()

Converts the collection to an array.

Declaration

cs-api-definition
public TInheritor[] ToArray()

Returns

TInheritor[]

An array of DocumentElements.

VerifyChildrenOverride(TInheritor)

Declaration

cs-api-definition
protected virtual void VerifyChildrenOverride(TInheritor item)

Parameters

item

TInheritor

Events

CollectionChanged

Occurs when the collection is changed.

Declaration

cs-api-definition
public event EventHandler CollectionChanged

Event Value

EventHandler

ElementAdded

Occurs when a DocumentElement is added.

Declaration

cs-api-definition
public event EventHandler<ElementAddedEventArgs> ElementAdded

Event Value

EventHandler<ElementAddedEventArgs>