[This is preliminary documentation and is subject to change.]
The ListWithEventsBase type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AddIndex | When overriden in derived class adds the PropertyDescriptor to the indexes used for searching. | |
| ApplySort | When overriden in derived class sorts the list based on a PropertyDescriptor and a ListSortDirection. | |
| Clear | When overriden in derived class removes all items from the ListWithEvents<(Of <(<'T>)>)>. | |
| Contains | When overriden in derived class determines whether the IList contains a specific value. | |
| Find | When overriden in derived class returns the index of the row that has the given PropertyDescriptor. | |
| IBindingList_AddNew | When overriden in derived class adds a new item to the list. | |
| ICollection_CopyTo | When overriden in derived class copies the elements of the ICollection to an Array, starting at a particular Array index. | |
| IEnumerable_GetEnumerator | When overriden in derived class returns an enumerator that iterates through a collection. | |
| IList_Add | When overriden in derived class adds an item to the ListWithEvents<(Of <(<'T>)>)>. | |
| IndexOf | When overriden in derived class determines the index of a specific item in the IList. | |
| Insert | When overriden in derived class inserts an item to the IList at the specified index. | |
| Lock | When overiden in derived class sets the Locked to True | |
| LockAllowItemCancel | When overiden in derived class sets IsAllowItemCancelLocked, so AllowItemCancel can no longer be changed. | |
| OnChanged | Raises the Changed event | |
| OnINotifyCollectionChanged_CollectionChanged | Raises the INotifyCollectionChanged_CollectionChanged event | |
| OnListChanged | Raises the ListChanged event | |
| OnPropertyCnaged | Raises the PropertyChanged()()()() event | |
| Remove | When overriden in derived class removes the first occurrence of a specific object from the IList. | |
| RemoveAt | When overriden in derived class removes the ListWithEvents<(Of <(<'T>)>)> item at the specified index. | |
| RemoveIndex | When overriden in derived class removes the PropertyDescriptor from the indexes used for searching. | |
| RemoveSort | When overriden in derived class removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection). | |
| ToArray1 | When overiden in derived class copies all elements of this collection to new Array | |
| Unlock | When overiden in derived class sets the Locked to False |
Extension Methods
| Name | Description | |
|---|---|---|
| Exists | Gets value indicating if given collection is non-empty (Defined by EnumerableT.) | |
| IsEmpty()()()() | Overloaded. Gets value indicationg if given colection is empty (Defined by CollectionTools.) | |
| IsEmpty()()()() | Overloaded. Gets value indicating if given collection is empty (Defined by EnumerableT.) | |
| Last()()()() | Overloaded. Gets last item in collection (Defined by CollectionTools.) | |
| Last()()()() | Overloaded. Gets last item in collection (Defined by CollectionTools.) | |
| Single | Gets value indicating if collection contains exactly one element (Defined by EnumerableT.) |
Properties
| Name | Description | |
|---|---|---|
| AddingReadOnly | When overiden in derived class determines ReadOnly property value for the Adding and ItemChanging events | |
| AllowAddCancelableEventsHandlers | When overiden in derived class determines if it is allowed to add handlers for events that supports cancellation | |
| AllowEdit | When overriden in derived class gets whether you can update items in the list. | |
| AllowItemCancel | When overiden in derived class gets or sets value indicating if items implementing ICollectionCancelItem are allowed to cancel itselves being added/removed to/from the list. | |
| AllowRemove | When overriden in derived class gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32). | |
| CanAddNew | When overriden in derived class gets whether you can add items to the list using AddNew()()()(). | |
| CancelError | When overiden in derived class gets value indicating if an OperationCanceledException is thrown when item operation is canceled in event handler. | |
| Count | When overriden in derived class gets the number of elements contained in the ListWithEvents<(Of <(<'T>)>)>. | |
| IList_Item | When overriden in derived class gets or sets the element at the specified index. | |
| IsAllowItemCancelLocked | When overiden in derived class gets value indicationg if value of the AllowItemCancel can be changed | |
| IsFixedSize | When overriden in derived class gets a value indicating whether the IList has a fixed size. | |
| IsReadOnly | When overriden in derived class gets a value indicating whether the ListWithEvents<(Of <(<'T>)>)> is read-only (always false). | |
| IsSorted | When overriden in derived class gets whether the items in the list are sorted. | |
| IsSynchronized | When overriden in derived class gets a value indicating whether access to the ICollection is synchronized (thread safe). | |
| Locked | When overiden in derived class determines if the ListWithEvents<(Of <(<'T>)>)> isn locked (being locked prevents if from being edited) | |
| Owner | When overriden in derived class represents custom property wher owner of the list can be stored to provide bi-directional reference | |
| SortDirection | When overriden in derived class gets the direction of the sort. | |
| SortProperty | When overriden in derived class gets the PropertyDescriptor that is being used for sorting. | |
| SupportsChangeNotification | When overriden in derived class gets whether a ListChanged event is raised when the list changes or an item in the list changes. | |
| SupportsSearching | When overriden in derived class gets whether the list supports searching using the Find(PropertyDescriptor, Object) method. | |
| SupportsSorting | When overriden in derived class gets whether the list supports sorting. | |
| SyncRoot | When overriden in derived class gets an object that can be used to synchronize access to the ICollection. |
Events
| Name | Description | |
|---|---|---|
| Changed | Raised when value of member changes | |
| INotifyCollectionChanged_CollectionChanged | Occurs when the collection changes. Implements the CollectionChanged event. This event is provided for compatibility with INotifyCollectionChanged interface. ListWithEvents<(Of <(<'T>)>)> provides CollectionChanged event which provides detailed information about what has with the collection. | |
| ListChanged | Occurs when the list changes or an item in the list changes. |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
| INotifyPropertyChanged..::..PropertyChanged |