Class EntityCollectionBase

Base implemntation of entity collection

Inheritance
System.Object
System.Collections.CollectionBase
EntityCollectionBase
BookmarkCollection
CellCollection
ColumnCollection
DocumentCollection
ListLevelCollection
ParagraphCollection
ParagraphItemCollection
RowCollection
SectionCollection
ShapeCollection
StyleCollection
TabCollection
TableColumnCollection
TextBoxCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
System.Collections.CollectionBase.Capacity
System.Collections.CollectionBase.Clear()
System.Collections.CollectionBase.Count
System.Collections.CollectionBase.GetEnumerator()
System.Collections.CollectionBase.InnerList
System.Collections.CollectionBase.List
System.Collections.CollectionBase.OnClear()
System.Collections.CollectionBase.OnClearComplete()
System.Collections.CollectionBase.OnInsert(System.Int32, System.Object)
System.Collections.CollectionBase.OnRemove(System.Int32, System.Object)
System.Collections.CollectionBase.OnSet(System.Int32, System.Object, System.Object)
System.Collections.CollectionBase.OnValidate(System.Object)
System.Collections.CollectionBase.RemoveAt(System.Int32)
System.Collections.CollectionBase.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.CollectionBase.System.Collections.ICollection.IsSynchronized
System.Collections.CollectionBase.System.Collections.ICollection.SyncRoot
System.Collections.CollectionBase.System.Collections.IList.Add(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Contains(System.Object)
System.Collections.CollectionBase.System.Collections.IList.get_Item(System.Int32)
System.Collections.CollectionBase.System.Collections.IList.IndexOf(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Insert(System.Int32, System.Object)
System.Collections.CollectionBase.System.Collections.IList.IsFixedSize
System.Collections.CollectionBase.System.Collections.IList.IsReadOnly
System.Collections.CollectionBase.System.Collections.IList.Item[System.Int32]
System.Collections.CollectionBase.System.Collections.IList.Remove(System.Object)
System.Collections.CollectionBase.System.Collections.IList.set_Item(System.Int32, System.Object)
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.DLS.Collections
Assembly: Syncfusion.DLS.Base.dll
Syntax
public abstract class EntityCollectionBase : CollectionBase, IXDLSSerializableCollection, ICollectionBase, IList, ICollection, IEnumerable

Constructors

EntityCollectionBase(IEntityBase)

Creates new collection by specified owner.

Declaration
protected EntityCollectionBase(IEntityBase owner)
Parameters
Type Name Description
IEntityBase owner

Properties

Document

Gets entity document.

Declaration
public IDocument Document { get; }
Property Value
Type
IDocument

DocumentEx

Gets DLS document implementation.

Declaration
protected Document DocumentEx { get; }
Property Value
Type
Document

Owner

Gets entity collection owner.

Declaration
protected IEntityBase Owner { get; }
Property Value
Type
IEntityBase

TagItemName

Gets name of xml tag

Declaration
public virtual string TagItemName { get; }
Property Value
Type
System.String

UpdateRestrictedForItemOwner

When set this property to TRUE, item Owner property will not updated.

Declaration
protected bool UpdateRestrictedForItemOwner { get; set; }
Property Value
Type
System.Boolean

Methods

CreateItem(IXDLSContentReader)

Creates the item.

Declaration
protected virtual object CreateItem(IXDLSContentReader reader)
Parameters
Type Name Description
IXDLSContentReader reader

The reader.
Returns
Type
System.Object

GetItemType(IXDLSContentReader, Type, Object)

Gets the type of the item.

Declaration
protected object GetItemType(IXDLSContentReader reader, Type enumType, object defValue)
Parameters
Type Name Description
IXDLSContentReader reader

The reader.
System.Type enumType

Type of the enum.
System.Object defValue

The def value.
Returns
Type
System.Object

IndexOf(IEntityBase)

Gets index of the specified item in the collection.

Declaration
public int IndexOf(IEntityBase item)
Parameters
Type Name Description
IEntityBase item

The specified entity item.
Returns
Type
System.Int32

OnInsertComplete(Int32, Object)

Performs additional custom processes after inserting a new element into the System.Collections.CollectionBase instance.

Declaration
protected override void OnInsertComplete(int index, object value)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which to insert value.
System.Object value

The new value of the element at index.
Overrides
System.Collections.CollectionBase.OnInsertComplete(System.Int32, System.Object)

OnRemoveComplete(Int32, Object)

Declaration
protected override void OnRemoveComplete(int index, object value)
Parameters
Type Name Description
System.Int32 index
System.Object value
Overrides
System.Collections.CollectionBase.OnRemoveComplete(System.Int32, System.Object)

OnSetComplete(Int32, Object, Object)

Declaration
protected override void OnSetComplete(int index, object oldValue, object newValue)
Parameters
Type Name Description
System.Int32 index
System.Object oldValue
System.Object newValue
Overrides
System.Collections.CollectionBase.OnSetComplete(System.Int32, System.Object, System.Object)

RemoveOwner(EntityBase)

Updates owner in specified entity.

Declaration
protected void RemoveOwner(EntityBase ent)
Parameters
Type Name Description
EntityBase ent

UpdateOwner(EntityBase)

Updates owner in specified entity.

Declaration
protected void UpdateOwner(EntityBase ent)
Parameters
Type Name Description
EntityBase ent

Explicit Interface Implementations

IXDLSSerializableCollection.AddNewItem(IXDLSContentReader)

Collection must creates and adds new empty item.

Declaration
IXDLSSerializable IXDLSSerializableCollection.AddNewItem(IXDLSContentReader reader)
Parameters
Type Name Description
IXDLSContentReader reader
Returns
Type
IXDLSSerializable

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable

Extension Methods