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>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable
Inherited Members
NestedCollectionPersist.GetFacadingItems()
NestedCollectionPersist.IsDeleted
NestedPersistFacade.OnPreIdUpdateAsync()
NestedPersistFacade.OnPrimaryKeyRequestAsync(PKContainer)
NestedPersistFacade.OnPrimaryKeyUpdateAsync(PKContainer)
NestedPersistFacade.OnIdUpdateAsync()
NestedPersistFacade.OnSaveAsync(BatchSave)
NestedPersistFacade.OnSavedAsync(bool)
NestedPersist._saveOwner
NestedPersist._isSaving
NestedPersist.SetSaveOwner(INestedPersist)
NestedPersist.SaveAsync()
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>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable

Constructors

EntityCollectionBase()

Summary description for EntityCollectionBase.

Declaration
public EntityCollectionBase()

Fields

_innerList

Summary description for EntityCollectionBase.

Declaration
protected ArrayList _innerList
Field Value
Type Description
ArrayList

Properties

AllowEdit

Summary description for EntityCollectionBase.

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

AllowNew

Summary description for EntityCollectionBase.

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

AllowRemove

Summary description for EntityCollectionBase.

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

Count

The count of rows in the collection

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

IsDirty

Is the object dirty?

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
bool
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
bool

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
bool

IsSorted

Summary description for EntityCollectionBase.

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

this[int]

Get EntityBase item at the specified index

Declaration
public EntityBase this[int index] { get; }
Parameters
Type Name Description
int 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

Summary description for EntityCollectionBase.

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

SortProperty

Summary description for EntityCollectionBase.

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

SupportsChangeNotification

Summary description for EntityCollectionBase.

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

SupportsSearching

Summary description for EntityCollectionBase.

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

SupportsSorting

Summary description for EntityCollectionBase.

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

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
int

The index of the added entity.

AddIndex(PropertyDescriptor)

Summary description for EntityCollectionBase.

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

AddNew()

Summary description for EntityCollectionBase.

Declaration
public virtual EntityBase AddNew()
Returns
Type Description
EntityBase

ApplySort(PropertyDescriptor, ListSortDirection)

Summary description for EntityCollectionBase.

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
bool

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

CopyTo(Array, int)

Not implemented for TableRowsBase. CopyTo(Array, int)

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

CreateChild()

Summary description for EntityCollectionBase.

Declaration
protected abstract EntityBase CreateChild()
Returns
Type Description
EntityBase

DeleteAsync()

Summary description for EntityCollectionBase.

Declaration
public virtual Task DeleteAsync()
Returns
Type Description
Task

Find(PropertyDescriptor, object)

Summary description for EntityCollectionBase.

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

GetEnumerator()

Declaration of the IEnumerable implementation

Declaration
public override IEnumerator GetEnumerator()
Returns
Type Description
IEnumerator

Enumerator.

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
int

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)

Summary description for EntityCollectionBase.

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

RemoveSort()

Summary description for EntityCollectionBase.

Declaration
public void RemoveSort()

Events

CollectionChanged

Summary description for EntityCollectionBase.

Declaration
public event NotifyCollectionChangedEventHandler CollectionChanged
Event Type
Type Description
NotifyCollectionChangedEventHandler

ListChanged

Summary description for EntityCollectionBase.

Declaration
public event ListChangedEventHandler ListChanged
Event Type
Type Description
ListChangedEventHandler

Implements

INestedPersist
IEnumerable<T>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable

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