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

Inheritance diagram for Csla.ReadOnlyListBase< T, C >:

Public Member Functions
T	Clone ()
	Creates a clone of the object.
C[]	ToArray ()
	Get an array containing all items in the list.
Public Member Functions inherited from Csla.Core.ReadOnlyObservableBindingList< C >
	ReadOnlyObservableBindingList ()
	Creates an instance of the type.
Public Member Functions inherited from Csla.Core.ObservableBindingList< T >
T	AddNew ()
	Adds a new item to this collection.
async Task< T >	AddNewAsync ()
	Adds a new item to this collection.
void	AddRange (IEnumerable< T > range)
	Add a range of items to the list.
Task	WaitForIdle (TimeSpan timeout)
	Await this method to ensure business object is not busy.
virtual void	OnAddedNew (T item)
	Raises the AddedNew event.
	SuppressListChangedEventsClass (ObservableBindingList< TC > businessObject)
void	Dispose ()
Public Member Functions inherited from Csla.Core.MobileObservableCollection< T >
	LoadListModeObject (IMobileList target)
	Create instance of type.
void	Dispose ()
	Disposes the object.

Protected Member Functions

ReadOnlyListBase ()

Creates an instance of the type.

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.

virtual object GetClone ()

Creates a clone of the object.

virtual void DataPortal_OnDataPortalInvoke (DataPortalEventArgs e)

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

virtual void DataPortal_OnDataPortalInvokeComplete (DataPortalEventArgs e)

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

virtual void DataPortal_OnDataPortalException (DataPortalEventArgs e, Exception ex)

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

virtual void Child_OnDataPortalInvoke (DataPortalEventArgs e)

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

virtual void Child_OnDataPortalInvokeComplete (DataPortalEventArgs e)

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

virtual void Child_OnDataPortalException (DataPortalEventArgs e, Exception ex)

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

Protected Member Functions inherited from Csla.Core.ReadOnlyObservableBindingList< C >

override void OnCollectionChanged (NotifyCollectionChangedEventArgs e)

Method invoked when collection is changed.

override void SetLoadListMode (bool enabled)

Sets the LoadListMode for the collection.

override void OnGetState (Serialization.Mobile.SerializationInfo info)

Override this method to insert your field values into the MobileFormatter serialization stream.

override void OnSetState (Serialization.Mobile.SerializationInfo info)

Override this method to retrieve your field values from the MobileFormatter serialization stream.

override void OnGetMetastate (BinaryWriter writer)

Override this method to write field values directly to a binary stream for metastate serialization.

Parameters

writer Binary writer for the output stream.

override void OnSetMetastate (BinaryReader reader)

Override this method to read field values directly from a binary stream for metastate deserialization.

Parameters

reader Binary reader for the input stream.

override void OnSetChildren (Serialization.Mobile.SerializationInfo info, Serialization.Mobile.MobileFormatter formatter)

Override this method to retrieve your child object references from the MobileFormatter serialization stream.

Protected Member Functions inherited from Csla.Core.ObservableBindingList< T >

void OnRemovingItem (T removedItem)

Raise the RemovingItem event.

override void RemoveItem (int index)

Remove the item at the specified index.

virtual void OnBusyChanged (BusyChangedEventArgs args)

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

void OnBusyChanged (string propertyName, bool busy)

Raises the BusyChanged event for a specific property.

virtual void OnUnhandledAsyncException (ErrorEventArgs error)

Method invoked when an unhandled async exception has occurred.

void OnUnhandledAsyncException (object originalSender, Exception error)

Raises the UnhandledAsyncException event.

override void InsertItem (int index, T item)

Invoked when an item is inserted into the list.

virtual void OnAddEventHooks (T item)

Method invoked when events are hooked for a child object.

virtual void OnRemoveEventHooks (T item)

Method invoked when events are unhooked for a child object.

virtual void Deserialized ()

Invoked after the object has been deserialized to allow derived classes to perform custom post-deserialization processing.

virtual void OnChildChanged (ChildChangedEventArgs e)

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

virtual void Child_PropertyChanged (object? sender, PropertyChangedEventArgs e)

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

virtual T AddNewCore ()

Override this method to create a new object that is added to the collection.

virtual async Task< T > AddNewCoreAsync ()

Override this method to create a new object that is added to the collection.

override void OnCollectionChanged (NotifyCollectionChangedEventArgs e)

Raises the CollectionChanged event.

override void OnGetState (SerializationInfo info)

Override this method to get custom field values from the serialization stream.

override void OnSetState (SerializationInfo info)

Override this method to set custom field values into the serialization stream.

Protected Member Functions inherited from Csla.Core.MobileObservableCollection< T >

virtual void OnGetChildren (SerializationInfo info, MobileFormatter formatter)

Override this method to get custom child object values from the serialization stream.

virtual void OnSetChildren (SerializationInfo info, MobileFormatter formatter)

Override this method to set custom child object values into the serialization stream.

Properties
ApplicationContext	ApplicationContext `[get]`
	Gets the current ApplicationContext.
Properties inherited from Csla.Core.ReadOnlyObservableBindingList< C >
bool	IsReadOnly `[get, protected set]`
	Gets or sets a value indicating whether the list is readonly.
Properties inherited from Csla.Core.ObservableBindingList< T >
virtual bool	SupportsChangeNotificationCore `[get]`
	Gets a value indicating whether this object supports change notification.
bool	AllowEdit `[get, protected set]`
	Gets or sets a value indicating whether data binding can automatically edit items in this collection.
bool	AllowNew `[get, protected set]`
	Gets or sets a value indicating whether data binding can automatically add new items to this collection.
bool	AllowRemove `[get, protected set]`
	Gets or sets a value indicating whether data binding can automatically remove items from this collection.
bool	RaiseListChangedEvents `[get, set]`
	Gets or sets a value indicating whether the collection should raise changed events.
virtual bool	IsBusy `[get]`
	Gets the busy status for this object and its child objects.
virtual bool	IsSelfBusy `[get]`
	Gets the busy status for this object.
IDisposable	SuppressListChangedEvents `[get]`
	Use this object to suppress ListChangedEvents for an entire code block. May be nested in multiple levels for the same object.
Properties inherited from Csla.Core.MobileObservableCollection< 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.

Additional Inherited Members
Events inherited from Csla.Core.ObservableBindingList< T >
EventHandler< RemovingItemEventArgs >?	RemovingItem `[add, remove]`
	Implements a serialization-safe RemovingItem event.
BusyChangedEventHandler?	BusyChanged `[add, remove]`
	Event indicating that the busy status of the object has changed.
EventHandler< ErrorEventArgs >?	UnhandledAsyncException `[add, remove]`
	Event indicating that an exception occurred during an async operation.
EventHandler< ChildChangedEventArgs >?	ChildChanged `[add, remove]`
	Event raised when a child object has been changed.
EventHandler< AddedNewEventArgs< T > >?	AddedNew `[add, remove]`
	Event raised when a new object has been added to the collection.
Events inherited from Csla.Core.IObservableBindingList
EventHandler< RemovingItemEventArgs >?	RemovingItem
	Event indicating that an item is being removed from the list.
Events inherited from Csla.Core.INotifyBusy
BusyChangedEventHandler?	BusyChanged
	Event raised when the object's busy status changes.
Events inherited from Csla.Core.INotifyUnhandledAsyncException
EventHandler< ErrorEventArgs >?	UnhandledAsyncException
	Event indicating that an exception occurred during an asynchronous operation.
Events inherited from Csla.Core.INotifyChildChanged
EventHandler< ChildChangedEventArgs >?	ChildChanged
	Event indictating that a child object has changed.

Detailed Description

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

Template Parameters

T	Type of the list class.
C	Type of child objects contained in the list.

Type Constraints

T	:	ReadOnlyListBase
T	:	T
T	:	C

Member Function Documentation

◆ Child_OnDataPortalException()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.
ex	The Exception thrown during data access.

◆ Child_OnDataPortalInvoke()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ Child_OnDataPortalInvokeComplete()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ Clone()

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

inline

Creates a clone of the object.

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

◆ DataPortal_OnDataPortalException()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.
ex	The Exception thrown during data access.

◆ DataPortal_OnDataPortalInvoke()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ DataPortal_OnDataPortalInvokeComplete()

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

inlineprotectedvirtual

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

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ GetClone()

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

inlineprotectedvirtual

Creates a clone of the object.

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

◆ Initialize()

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

inlineprotectedvirtual

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

◆ ReadOnlyListBase()

Csla.ReadOnlyListBase< T, C >.ReadOnlyListBase ( )

inlineprotected

Creates an instance of the type.

◆ ToArray()

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

inline

Get an array containing all items in the list.

Property Documentation

◆ ApplicationContext

ApplicationContext Csla.ReadOnlyListBase< T, C >.ApplicationContext

getprotected

Gets the current ApplicationContext.

Implements Csla.Core.IUseApplicationContext.

The documentation for this class was generated from the following file:

csla/Source/Csla/ReadOnlyListBase.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Child_OnDataPortalException()

◆ Child_OnDataPortalInvoke()

◆ Child_OnDataPortalInvokeComplete()

◆ Clone()

◆ DataPortal_OnDataPortalException()

◆ DataPortal_OnDataPortalInvoke()

◆ DataPortal_OnDataPortalInvokeComplete()

◆ GetClone()

◆ Initialize()

◆ ReadOnlyListBase()

◆ ToArray()

Property Documentation

◆ ApplicationContext