EntitySubsetCollection Class

Represents a subset from the collection of specified type entities.

Inheritance
System.Object
EntitySubsetCollection
WParagraphCollection
WTableCollection
Implements
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public abstract class EntitySubsetCollection : IEntityCollectionBase, ICollectionBase, IEnumerable

Properties

Count

Gets the number of items in collection.

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32

The integer that represents the count of the items.

Document

Gets the current document. Read-only.

Declaration
public WordDocument Document { get; }
Property Value
Type Description
WordDocument

The WordDocument object.

Item[Int32]

Gets the Entity at the specified index.

Declaration
public Entity this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

The zero-based index of the entity to get.
Property Value
Type Description
Entity

The Entity at the specified index.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The index is not valid index in the IEntityCollectionBase.

Owner

Gets the owner of this EntitySubsetCollection. Ready-only.

Declaration
public Entity Owner { get; }
Property Value
Type Description
Entity

The Entity which is the owner element.

Methods

Clear()

Removes all the entities from the collection.

Declaration
public void Clear()

GetByIndex(Int32)

Gets the entity by its index.

Declaration
protected Entity GetByIndex(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the entity.
Returns
Type Description
Entity

The Entity at the specified index.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The index is not valid in the EntitySubsetCollection.

GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
public IEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.

Implements

System.Collections.IEnumerable