Class EntityCollectionBase
Summary description for EntityCollectionBase.
Inheritance
EntityCollectionBase
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
Properties
AllowEdit
Declaration
public bool AllowEdit { get; }
Property Value
AllowNew
Declaration
public bool AllowNew { get; }
Property Value
AllowRemove
Declaration
public bool AllowRemove { get; }
Property Value
Count
Declaration
public override int Count { get; }
Property Value
Overrides
IsDirty
Declaration
public override bool IsDirty { get; }
Property Value
Overrides
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
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
IsSorted
Declaration
public bool IsSorted { get; }
Property Value
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
SortDirection
Declaration
public ListSortDirection SortDirection { get; }
Property Value
SortProperty
Declaration
public PropertyDescriptor SortProperty { get; }
Property Value
SupportsChangeNotification
Declaration
public bool SupportsChangeNotification { get; }
Property Value
SupportsSearching
Declaration
public bool SupportsSearching { get; }
Property Value
SupportsSorting
Declaration
public bool SupportsSorting { get; }
Property Value
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
AddNew()
Declaration
public virtual EntityBase AddNew()
Returns
ApplySort(PropertyDescriptor, ListSortDirection)
Declaration
public void ApplySort(PropertyDescriptor property, ListSortDirection direction)
Parameters
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)
Declaration
public void CopyTo(Array list, int index)
Parameters
CreateChild()
Declaration
protected abstract EntityBase CreateChild()
Returns
Delete()
Declaration
public virtual void Delete()
Find(PropertyDescriptor, Object)
Declaration
public int Find(PropertyDescriptor property, object key)
Parameters
Returns
GetEnumerator()
Declaration
public override IEnumerator GetEnumerator()
Returns
Overrides
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
RemoveSort()
Declaration
Events
CollectionChanged
Declaration
public event NotifyCollectionChangedEventHandler CollectionChanged
Event Type
ListChanged
Declaration
public event ListChangedEventHandler ListChanged
Event Type
Explicit Interface Implementations
ISoCollection.Add(ISoItem)
Declaration
int ISoCollection.Add(ISoItem item)
Parameters
Returns
ISoCollection.AddNew()
Declaration
ISoItem ISoCollection.AddNew()
Returns
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
Declaration
bool ICollection.IsSynchronized { get; }
Returns
ICollection.SyncRoot
Declaration
object ICollection.SyncRoot { get; }
Returns
IList.Add(Object)
Declaration
Parameters
| Type |
Name |
Description |
| Object |
o |
The object to add.
|
Returns
| Type |
Description |
| Int32 |
The index of the added object.
|
IList.Clear()
Declaration
IList.get_Item(Int32)
Declaration
object IList.get_Item(int index)
Parameters
| Type |
Name |
Description |
| Int32 |
index |
|
Returns
IList.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
IList.Remove(Object)
Declaration
void IList.Remove(object o)
Parameters
| Type |
Name |
Description |
| Object |
o |
|
IList.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
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)