CSLA.NET 5.4.2
CSLA .NET is a software development framework that helps you build a reusable, maintainable object-oriented business layer for your app.
Csla.Core.ExtendedBindingList< T > Class Template Reference

Extends BindingList of T by adding extra behaviors. More...

Inheritance diagram for Csla.Core.ExtendedBindingList< T >:
Csla.Core.MobileBindingList< T > Csla.Core.IExtendedBindingList Csla.Serialization.Mobile.IMobileList Csla.Core.INotifyBusy Csla.Core.INotifyChildChanged Csla.Serialization.Mobile.ISerializationNotification Csla.Serialization.Mobile.IMobileList Csla.Serialization.Mobile.IMobileObject Csla.Core.INotifyUnhandledAsyncException Csla.Serialization.Mobile.IMobileObject Csla.DynamicBindingListBase< T >

Public Member Functions

void AddRange (System.Collections.Generic.IEnumerable< T > range)
 Add a range of items to the list. More...
 

Protected Member Functions

void OnRemovingItem (T removedItem)
 Raise the RemovingItem event. More...
 
override void RemoveItem (int index)
 Remove the item at the specified index. More...
 
virtual void OnBusyChanged (BusyChangedEventArgs args)
 Override this method to be notified when the IsBusy property has changed. More...
 
void OnBusyChanged (string propertyName, bool busy)
 Raises the BusyChanged event for a specific property. More...
 
virtual void OnUnhandledAsyncException (ErrorEventArgs error)
 Method invoked when an unhandled async exception has occurred. More...
 
void OnUnhandledAsyncException (object originalSender, Exception error)
 Raises the UnhandledAsyncException event. More...
 
override void InsertItem (int index, T item)
 Invoked when an item is inserted into the list. More...
 
virtual void OnAddEventHooks (T item)
 Method invoked when events are hooked for a child object. More...
 
virtual void OnRemoveEventHooks (T item)
 Method invoked when events are unhooked for a child object. More...
 
virtual void OnDeserialized ()
 This method is called on a newly deserialized object after deserialization is complete. More...
 
virtual void OnChildChanged (ChildChangedEventArgs e)
 Raises the ChildChanged event, indicating that a child object has been changed. More...
 
virtual void Child_PropertyChanged (object sender, PropertyChangedEventArgs e)
 Handles any PropertyChanged event from a child object and echoes it up as a ChildChanged event. More...
 
- Protected Member Functions inherited from Csla.Core.MobileBindingList< T >
virtual void SetLoadListMode (bool enabled)
 Sets the load list mode for the list More...
 
virtual void OnGetState (SerializationInfo info)
 Override this method to get custom field values from the serialization stream. More...
 
virtual void OnGetChildren (SerializationInfo info, MobileFormatter formatter)
 Override this method to get custom child object values from the serialization stream. More...
 
virtual void OnSetState (SerializationInfo info)
 Override this method to set custom field values into the serialization stream. More...
 
virtual void OnSetChildren (SerializationInfo info, MobileFormatter formatter)
 Override this method to set custom child object values into the serialization stream. More...
 

Properties

EventHandler< RemovingItemEventArgsRemovingItem
 Implements a serialization-safe RemovingItem event. More...
 
BusyChangedEventHandler BusyChanged
 Event indicating that the busy status of the object has changed. More...
 
virtual bool IsBusy [get]
 Gets the busy status for this object and its child objects. More...
 
virtual bool IsSelfBusy [get]
 Gets the busy status for this object. More...
 
EventHandler< ErrorEventArgsUnhandledAsyncException
 Event indicating that an exception occurred during an async operation. More...
 
EventHandler< Csla.Core.ChildChangedEventArgsChildChanged
 Event raised when a child object has been changed. More...
 
IDisposable SuppressListChangedEvents [get]
 Use this object to suppress ListChangedEvents for an entire code block. More...
 
- Properties inherited from Csla.Core.MobileBindingList< T >
LoadListModeObject LoadListMode [get]
 By wrapping this property inside Using block you can set property values on current business object without raising PropertyChanged events and checking user rights. More...
 
- Properties inherited from Csla.Core.INotifyBusy
bool IsBusy [get]
 Gets a value indicating whether the object, or any of the object's child objects, are busy running an asynchronous operation. More...
 
bool IsSelfBusy [get]
 Gets a value indicating whether the object is busy running an asynchronous operation. More...
 

Additional Inherited Members

- Events inherited from Csla.Core.IExtendedBindingList
EventHandler< RemovingItemEventArgsRemovingItem
 Event indicating that an item is being removed from the list. More...
 
- Events inherited from Csla.Core.INotifyBusy
BusyChangedEventHandler BusyChanged
 Event raised when the object's busy status changes. More...
 
- Events inherited from Csla.Core.INotifyUnhandledAsyncException
EventHandler< ErrorEventArgsUnhandledAsyncException
 Event indicating that an exception occurred during an asynchronous operation. More...
 
- Events inherited from Csla.Core.INotifyChildChanged
EventHandler< ChildChangedEventArgsChildChanged
 Event indictating that a child object has changed. More...
 

Detailed Description

Extends BindingList of T by adding extra behaviors.

Template Parameters
TType of item contained in list.

Definition at line 24 of file ExtendedBindingList.cs.

Member Function Documentation

◆ AddRange()

void Csla.Core.ExtendedBindingList< T >.AddRange ( System.Collections.Generic.IEnumerable< T >  range)

Add a range of items to the list.

Parameters
rangeList of items to add.

Definition at line 101 of file ExtendedBindingList.cs.

◆ Child_PropertyChanged()

virtual void Csla.Core.ExtendedBindingList< T >.Child_PropertyChanged ( object  sender,
PropertyChangedEventArgs  e 
)
protectedvirtual

Handles any PropertyChanged event from a child object and echoes it up as a ChildChanged event.

Parameters
senderObject that raised the event.
eProperty changed args.

Reimplemented in Csla.BusinessBindingListBase< T, C >.

Definition at line 384 of file ExtendedBindingList.cs.

◆ InsertItem()

override void Csla.Core.ExtendedBindingList< T >.InsertItem ( int  index,
item 
)
protected

Invoked when an item is inserted into the list.

Parameters
indexIndex of new item.
itemReference to new item.

Definition at line 214 of file ExtendedBindingList.cs.

◆ OnAddEventHooks()

virtual void Csla.Core.ExtendedBindingList< T >.OnAddEventHooks ( item)
protectedvirtual

Method invoked when events are hooked for a child object.

Parameters
itemReference to child object.

Definition at line 226 of file ExtendedBindingList.cs.

◆ OnBusyChanged() [1/2]

virtual void Csla.Core.ExtendedBindingList< T >.OnBusyChanged ( BusyChangedEventArgs  args)
protectedvirtual

Override this method to be notified when the IsBusy property has changed.

Parameters
argsEvent arguments.

Definition at line 126 of file ExtendedBindingList.cs.

◆ OnBusyChanged() [2/2]

void Csla.Core.ExtendedBindingList< T >.OnBusyChanged ( string  propertyName,
bool  busy 
)
protected

Raises the BusyChanged event for a specific property.

Parameters
propertyNameName of the property.
busyNew busy value.

Definition at line 137 of file ExtendedBindingList.cs.

◆ OnChildChanged()

virtual void Csla.Core.ExtendedBindingList< T >.OnChildChanged ( ChildChangedEventArgs  e)
protectedvirtual

Raises the ChildChanged event, indicating that a child object has been changed.

Parameters
eChildChangedEventArgs object.

Definition at line 327 of file ExtendedBindingList.cs.

◆ OnDeserialized()

virtual void Csla.Core.ExtendedBindingList< T >.OnDeserialized ( )
protectedvirtual

This method is called on a newly deserialized object after deserialization is complete.

Reimplemented in Csla.BusinessBindingListBase< T, C >, and Csla.DynamicBindingListBase< T >.

Definition at line 275 of file ExtendedBindingList.cs.

◆ OnRemoveEventHooks()

virtual void Csla.Core.ExtendedBindingList< T >.OnRemoveEventHooks ( item)
protectedvirtual

Method invoked when events are unhooked for a child object.

Parameters
itemReference to child object.

Definition at line 251 of file ExtendedBindingList.cs.

◆ OnRemovingItem()

void Csla.Core.ExtendedBindingList< T >.OnRemovingItem ( removedItem)
protected

Raise the RemovingItem event.

Parameters
removedItemA reference to the item that is being removed.

Definition at line 72 of file ExtendedBindingList.cs.

◆ OnUnhandledAsyncException() [1/2]

virtual void Csla.Core.ExtendedBindingList< T >.OnUnhandledAsyncException ( ErrorEventArgs  error)
protectedvirtual

Method invoked when an unhandled async exception has occurred.

Parameters
errorEvent arguments.

Definition at line 188 of file ExtendedBindingList.cs.

◆ OnUnhandledAsyncException() [2/2]

void Csla.Core.ExtendedBindingList< T >.OnUnhandledAsyncException ( object  originalSender,
Exception  error 
)
protected

Raises the UnhandledAsyncException event.

Parameters
originalSenderOriginal sender of event.
errorException that occurred.

Definition at line 199 of file ExtendedBindingList.cs.

◆ RemoveItem()

override void Csla.Core.ExtendedBindingList< T >.RemoveItem ( int  index)
protected

Remove the item at the specified index.

Parameters
indexThe zero-based index of the item to remove.

Definition at line 90 of file ExtendedBindingList.cs.

Property Documentation

◆ BusyChanged

Event indicating that the busy status of the object has changed.

Definition at line 115 of file ExtendedBindingList.cs.

◆ ChildChanged

EventHandler<Csla.Core.ChildChangedEventArgs> Csla.Core.ExtendedBindingList< T >.ChildChanged
addremove

Event raised when a child object has been changed.

Definition at line 305 of file ExtendedBindingList.cs.

◆ IsBusy

virtual bool Csla.Core.ExtendedBindingList< T >.IsBusy
get

Gets the busy status for this object and its child objects.

Definition at line 148 of file ExtendedBindingList.cs.

◆ IsSelfBusy

virtual bool Csla.Core.ExtendedBindingList< T >.IsSelfBusy
get

Gets the busy status for this object.

Definition at line 159 of file ExtendedBindingList.cs.

◆ RemovingItem

EventHandler<RemovingItemEventArgs> Csla.Core.ExtendedBindingList< T >.RemovingItem
addremove

Implements a serialization-safe RemovingItem event.

Definition at line 38 of file ExtendedBindingList.cs.

◆ SuppressListChangedEvents

IDisposable Csla.Core.ExtendedBindingList< T >.SuppressListChangedEvents
get

Use this object to suppress ListChangedEvents for an entire code block.

May be nested in multiple levels for the same object.

Definition at line 404 of file ExtendedBindingList.cs.

◆ UnhandledAsyncException

EventHandler<ErrorEventArgs> Csla.Core.ExtendedBindingList< T >.UnhandledAsyncException
addremove

Event indicating that an exception occurred during an async operation.

Definition at line 177 of file ExtendedBindingList.cs.