Show / Hide Table of Contents

Class EntityCollectionBase

Summary description for EntityCollectionBase.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
EntityCollectionBase
AppointmentCollection
ContactCollection
DocumentCollection
PersonCollection
ProjectCollection
ProjectMemberCollection
SaleCollection
SelectionCollection
Implements
INestedPersist
IEnumerable<INestedPersist>
ISoCollection
IList
ICollection
IEnumerable
INotifyCollectionChanged
IBindingList
Inherited Members
NestedCollectionPersist.GetFacadingItems()
NestedCollectionPersist.IEnumerable<INestedPersist>.GetEnumerator()
NestedCollectionPersist.IsDeleted
NestedPersistFacade.OnPreIdUpdate()
NestedPersistFacade.OnPrimaryKeyRequest(PKContainer)
NestedPersistFacade.OnPrimaryKeyUpdate(PKContainer)
NestedPersistFacade.OnIdUpdate()
NestedPersistFacade.OnSave(BatchSave)
NestedPersistFacade.OnSaved(Boolean)
NestedPersist._saveOwner
NestedPersist._isSaving
NestedPersist.SetSaveOwner(INestedPersist)
NestedPersist.Save()
NestedPersist.INestedPersist.OnPreIdUpdate()
NestedPersist.INestedPersist.OnPrimaryKeyRequest(PKContainer)
NestedPersist.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
NestedPersist.INestedPersist.OnIdUpdate()
NestedPersist.INestedPersist.OnSave(BatchSave)
NestedPersist.INestedPersist.OnSaved(Boolean)
NestedPersist.IsSaving
NestedPersist.IsMarkedForDelete
NestedPersist.OnElementSaved
NestedPersist.OnElementIdUpdate
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public abstract class EntityCollectionBase : NestedCollectionPersist, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, ITableRowLoadHandlerFactory, INotifyCollectionChanged, IBindingList

Constructors

EntityCollectionBase()

Declaration
public EntityCollectionBase()

Fields

_innerList

Declaration
protected ArrayList _innerList
Field Value
Type Description
ArrayList

Properties

AllowEdit

Declaration
public bool AllowEdit { get; }
Property Value
Type Description
Boolean

AllowNew

Declaration
public bool AllowNew { get; }
Property Value
Type Description
Boolean

AllowRemove

Declaration
public bool AllowRemove { get; }
Property Value
Type Description
Boolean

Count

Declaration
public override int Count { get; }
Property Value
Type Description
Int32
Overrides
NestedCollectionPersist.Count

IsDirty

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides
NestedPersistFacade.IsDirty

IsFixedSize

A collection with a fixed size does not allow the addition or removal of elements after the collection is created, but it allows the modification of existing elements.

Declaration
public bool IsFixedSize { get; }
Property Value
Type Description
Boolean

IsReadOnly

A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
Boolean

IsSorted

Declaration
public bool IsSorted { get; }
Property Value
Type Description
Boolean

Item[Int32]

Get EntityBase item at the specified index

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

Index of object to retrieve

Property Value
Type Description
EntityBase

Object at specified index

Sentries

The collection of sentries that are guarding this collection of rows. This collection is used by RDB entities which return HDB collections.

For example, the contact.Faxes returns a PhoneRows collection in which each row will need to check the contact's sentry for permission to read/write their field

Declaration
public abstract SentryCollection Sentries { get; }
Property Value
Type Description
SentryCollection

SortDirection

Declaration
public ListSortDirection SortDirection { get; }
Property Value
Type Description
ListSortDirection

SortProperty

Declaration
public PropertyDescriptor SortProperty { get; }
Property Value
Type Description
PropertyDescriptor

SupportsChangeNotification

Declaration
public bool SupportsChangeNotification { get; }
Property Value
Type Description
Boolean

SupportsSearching

Declaration
public bool SupportsSearching { get; }
Property Value
Type Description
Boolean

SupportsSorting

Declaration
public bool SupportsSorting { get; }
Property Value
Type Description
Boolean

Methods

Add(EntityBase)

Add one entity to the collection.

Declaration
protected virtual int Add(EntityBase entity)
Parameters
Type Name Description
EntityBase entity

An instance of entity to be added to the collection.

Returns
Type Description
Int32

The index of the added entity.

AddIndex(PropertyDescriptor)

Declaration
public void AddIndex(PropertyDescriptor property)
Parameters
Type Name Description
PropertyDescriptor property

AddNew()

Declaration
public virtual EntityBase AddNew()
Returns
Type Description
EntityBase

ApplySort(PropertyDescriptor, ListSortDirection)

Declaration
public void ApplySort(PropertyDescriptor property, ListSortDirection direction)
Parameters
Type Name Description
PropertyDescriptor property
ListSortDirection direction

Contains(Object)

Checks if the list contains the object or not. Implemented in classes inheriting TableRowBase. Contains(Object)

Declaration
public bool Contains(object o)
Parameters
Type Name Description
Object o

The object to locate in the Array.

Returns
Type Description
Boolean

True if value is found in the Array; otherwise, False

CopyTo(Array, Int32)

Not implemented for TableRowsBase. CopyTo(Array, Int32)

Declaration
public void CopyTo(Array list, int index)
Parameters
Type Name Description
Array list
Int32 index

CreateChild()

Declaration
protected abstract EntityBase CreateChild()
Returns
Type Description
EntityBase

Delete()

Declaration
public virtual void Delete()

Find(PropertyDescriptor, Object)

Declaration
public int Find(PropertyDescriptor property, object key)
Parameters
Type Name Description
PropertyDescriptor property
Object key
Returns
Type Description
Int32

GetEnumerator()

Declaration
public override IEnumerator GetEnumerator()
Returns
Type Description
IEnumerator
Overrides
NestedCollectionPersist.GetEnumerator()

IndexOf(Object)

Returns the object at the given index. Implemented in classes inheriting TableRowBase. IndexOf(Object)

Declaration
public int IndexOf(object o)
Parameters
Type Name Description
Object o

The object

Returns
Type Description
Int32

The index of the object.

Remove(EntityBase)

Removes the given row from the collection

Declaration
protected virtual void Remove(EntityBase entity)
Parameters
Type Name Description
EntityBase entity

the row to be removed

RemoveIndex(PropertyDescriptor)

Declaration
public void RemoveIndex(PropertyDescriptor property)
Parameters
Type Name Description
PropertyDescriptor property

RemoveSort()

Declaration
public void RemoveSort()

Events

CollectionChanged

Declaration
public event NotifyCollectionChangedEventHandler CollectionChanged
Event Type
Type Description
NotifyCollectionChangedEventHandler

ListChanged

Declaration
public event ListChangedEventHandler ListChanged
Event Type
Type Description
ListChangedEventHandler

Explicit Interface Implementations

ISoCollection.Add(ISoItem)

Declaration
int ISoCollection.Add(ISoItem item)
Parameters
Type Name Description
ISoItem item
Returns
Type Description
Int32

ISoCollection.AddNew()

Declaration
ISoItem ISoCollection.AddNew()
Returns
Type Description
ISoItem

ICollection.Count

The number of elements contained in the underlying collection.

Declaration
int ICollection.Count { get; }
Returns
Type Description
Int32

Number of items in underlying collection.

ICollection.IsSynchronized

IsSynchronized

Declaration
bool ICollection.IsSynchronized { get; }
Returns
Type Description
Boolean

ICollection.SyncRoot

SyncRoot

Declaration
object ICollection.SyncRoot { get; }
Returns
Type Description
Object

IList.Add(Object)

Implemented in child-objects. Add(Object)

Declaration
int IList.Add(object o)
Parameters
Type Name Description
Object o

The object to add.

Returns
Type Description
Int32

The index of the added object.

IList.Clear()

Clears the list. Clear()

Declaration
void IList.Clear()

IList.get_Item(Int32)

Declaration
object IList.get_Item(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
Object

IList.Insert(Int32, Object)

Will add the given object to the collection. Insert(Int32, Object)

Declaration
void IList.Insert(int i, object o)
Parameters
Type Name Description
Int32 i

Not used. Object will be added as last element.

Object o

The object to add.

IList.Item[Int32]

Declaration
object IList.this[] { get; set; }
Parameters
Type Name Description
Int32 index
Returns
Type Description
Object

IList.Remove(Object)

Declaration
void IList.Remove(object o)
Parameters
Type Name Description
Object o

IList.RemoveAt(Int32)

Will remove object at given index. RemoveAt(Int32)

Declaration
void IList.RemoveAt(int index)
Parameters
Type Name Description
Int32 index

The index pointing to the object to remove.

IList.set_Item(Int32, Object)

Declaration
void IList.set_Item(int index, object value)
Parameters
Type Name Description
Int32 index
Object value

Implements

INestedPersist
System.Collections.Generic.IEnumerable<T>
ISoCollection
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top