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.ReadOnlyBindingListBase< T, C > Class Template Reference

This is the base class from which readonly collections of readonly objects should be derived. More...

Inheritance diagram for Csla.ReadOnlyBindingListBase< T, C >:
Csla.Core.ReadOnlyBindingList< C > Csla.Core.IReadOnlyCollection Csla.Core.ExtendedBindingList< C > Csla.Core.IBusinessObject Csla.Core.IBusinessObject

Public Member Functions

Clone ()
 Creates a clone of the object. More...
 
C[] ToArray ()
 Get an array containing all items in the list. More...
 
- Public Member Functions inherited from Csla.Core.ExtendedBindingList< C >
void AddRange (System.Collections.Generic.IEnumerable< T > range)
 Add a range of items to the list. More...
 

Protected Member Functions

 ReadOnlyBindingListBase ()
 Creates an instance of the object. More...
 
virtual void Initialize ()
 Override this method to set up event handlers so user code in a partial class can respond to events raised by generated code. More...
 
virtual object GetClone ()
 Creates a clone of the object. More...
 
virtual void DataPortal_OnDataPortalInvoke (DataPortalEventArgs e)
 Called by the server-side DataPortal prior to calling the requested DataPortal_xyz method. More...
 
virtual void DataPortal_OnDataPortalInvokeComplete (DataPortalEventArgs e)
 Called by the server-side DataPortal after calling the requested DataPortal_xyz method. More...
 
virtual void DataPortal_OnDataPortalException (DataPortalEventArgs e, Exception ex)
 Called by the server-side DataPortal if an exception occurs during data access. More...
 
virtual void Child_OnDataPortalInvoke (DataPortalEventArgs e)
 Called by the server-side DataPortal prior to calling the requested DataPortal_XYZ method. More...
 
virtual void Child_OnDataPortalInvokeComplete (DataPortalEventArgs e)
 Called by the server-side DataPortal after calling the requested DataPortal_XYZ method. More...
 
virtual void Child_OnDataPortalException (DataPortalEventArgs e, Exception ex)
 Called by the server-side DataPortal if an exception occurs during data access. More...
 
- Protected Member Functions inherited from Csla.Core.ReadOnlyBindingList< C >
override void SetLoadListMode (bool enabled)
 Sets the LoadListMode for the collection More...
 
 ReadOnlyBindingList ()
 Creates an instance of the object. More...
 
override void ClearItems ()
 Prevents clearing the collection. More...
 
override object AddNewCore ()
 Prevents insertion of items into the collection. More...
 
override void InsertItem (int index, C item)
 Prevents insertion of items into the collection. More...
 
override void RemoveItem (int index)
 Removes the item at the specified index if the collection is not in readonly mode. More...
 
override void SetItem (int index, C item)
 Replaces the item at the specified index with the specified item if the collection is not in readonly mode. More...
 
override void OnGetState (Csla.Serialization.Mobile.SerializationInfo info)
 Override this method to insert your field values into the MobileFormatter serialzation stream. More...
 
override void OnSetState (Csla.Serialization.Mobile.SerializationInfo info)
 Override this method to retrieve your field values from the MobileFormatter serialzation stream. More...
 
override void OnSetChildren (Csla.Serialization.Mobile.SerializationInfo info, Csla.Serialization.Mobile.MobileFormatter formatter)
 Override this method to retrieve your child object references from the MobileFormatter serialzation stream. More...
 
- Protected Member Functions inherited from Csla.Core.ExtendedBindingList< C >
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...
 

Additional Inherited Members

- Properties inherited from Csla.Core.ReadOnlyBindingList< C >
bool IsReadOnly [getprotected set]
 Gets or sets a value indicating whether the list is readonly. More...
 
virtual bool IsReadOnlyCore [getset]
 Gets or sets a value indicating whether the list is readonly. More...
 
override bool IsBusy [get]
 Gets a value indicating whether this object or its child objects are busy. More...
 
- Properties inherited from Csla.Core.ExtendedBindingList< C >
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.IBusinessObject
int Identity [get]
 Gets a value representing this object instance's unique identity value within the business object graph. More...
 

Detailed Description

This is the base class from which readonly collections of readonly objects should be derived.

Template Parameters
TType of the list class.
CType of child objects contained in the list.
Type Constraints
T :ReadOnlyBindingListBase 
T :T 
T :C 

Definition at line 42 of file ReadOnlyBindingListBase.cs.

Constructor & Destructor Documentation

◆ ReadOnlyBindingListBase()

Creates an instance of the object.

Definition at line 51 of file ReadOnlyBindingListBase.cs.

Member Function Documentation

◆ Child_OnDataPortalException()

virtual void Csla.ReadOnlyBindingListBase< T, C >.Child_OnDataPortalException ( DataPortalEventArgs  e,
Exception  ex 
)
protectedvirtual

Called by the server-side DataPortal if an exception occurs during data access.

Parameters
eThe DataPortalContext object passed to the DataPortal.
exThe Exception thrown during data access.

Definition at line 178 of file ReadOnlyBindingListBase.cs.

◆ Child_OnDataPortalInvoke()

virtual void Csla.ReadOnlyBindingListBase< T, C >.Child_OnDataPortalInvoke ( DataPortalEventArgs  e)
protectedvirtual

Called by the server-side DataPortal prior to calling the requested DataPortal_XYZ method.

Parameters
eThe DataPortalContext object passed to the DataPortal.

Definition at line 155 of file ReadOnlyBindingListBase.cs.

◆ Child_OnDataPortalInvokeComplete()

virtual void Csla.ReadOnlyBindingListBase< T, C >.Child_OnDataPortalInvokeComplete ( DataPortalEventArgs  e)
protectedvirtual

Called by the server-side DataPortal after calling the requested DataPortal_XYZ method.

Parameters
eThe DataPortalContext object passed to the DataPortal.

Definition at line 166 of file ReadOnlyBindingListBase.cs.

◆ Clone()

T Csla.ReadOnlyBindingListBase< T, C >.Clone ( )

Creates a clone of the object.

Returns
A new object containing the exact data of the original object.

Definition at line 90 of file ReadOnlyBindingListBase.cs.

◆ DataPortal_OnDataPortalException()

virtual void Csla.ReadOnlyBindingListBase< T, C >.DataPortal_OnDataPortalException ( DataPortalEventArgs  e,
Exception  ex 
)
protectedvirtual

Called by the server-side DataPortal if an exception occurs during data access.

Parameters
eThe DataPortalContext object passed to the DataPortal.
exThe Exception thrown during data access.

Definition at line 143 of file ReadOnlyBindingListBase.cs.

◆ DataPortal_OnDataPortalInvoke()

virtual void Csla.ReadOnlyBindingListBase< T, C >.DataPortal_OnDataPortalInvoke ( DataPortalEventArgs  e)
protectedvirtual

Called by the server-side DataPortal prior to calling the requested DataPortal_xyz method.

Parameters
eThe DataPortalContext object passed to the DataPortal.

Definition at line 118 of file ReadOnlyBindingListBase.cs.

◆ DataPortal_OnDataPortalInvokeComplete()

virtual void Csla.ReadOnlyBindingListBase< T, C >.DataPortal_OnDataPortalInvokeComplete ( DataPortalEventArgs  e)
protectedvirtual

Called by the server-side DataPortal after calling the requested DataPortal_xyz method.

Parameters
eThe DataPortalContext object passed to the DataPortal.

Definition at line 130 of file ReadOnlyBindingListBase.cs.

◆ GetClone()

virtual object Csla.ReadOnlyBindingListBase< T, C >.GetClone ( )
protectedvirtual

Creates a clone of the object.

Returns
A new object containing the exact data of the original object.

Definition at line 79 of file ReadOnlyBindingListBase.cs.

◆ Initialize()

virtual void Csla.ReadOnlyBindingListBase< T, C >.Initialize ( )
protectedvirtual

Override this method to set up event handlers so user code in a partial class can respond to events raised by generated code.

Definition at line 63 of file ReadOnlyBindingListBase.cs.

◆ ToArray()

C[] Csla.ReadOnlyBindingListBase< T, C >.ToArray ( )

Get an array containing all items in the list.

Definition at line 189 of file ReadOnlyBindingListBase.cs.