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.ReadOnlyObservableBindingList< C > Class Template Reference

A readonly version of ObservableBindingList. More...

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

Public Member Functions

 ReadOnlyObservableBindingList ()
 Creates an instance of the object. More...
 
- Public Member Functions inherited from Csla.Core.ObservableBindingList< C >
AddNew ()
 Adds a new item to this collection. More...
 
void AddRange (System.Collections.Generic.IEnumerable< T > range)
 Add a range of items to the list. More...
 
virtual void OnAddedNew (T item)
 Raises the AddedNew event. More...
 

Protected Member Functions

override void OnCollectionChanged (NotifyCollectionChangedEventArgs e)
 Method invoked when collection is changed. More...
 
override void SetLoadListMode (bool enabled)
 Sets the LoadListMode for the collection 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.ObservableBindingList< 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...
 
virtual T AddNewCore ()
 Override this method to create a new object that is added to the collection. More...
 
override void OnCollectionChanged (NotifyCollectionChangedEventArgs e)
 Raises the CollectionChanged event. More...
 
override void OnGetState (SerializationInfo info)
 Override this method to get custom field values from the serialization stream. More...
 
override void OnSetState (SerializationInfo info)
 Override this method to set custom field values into the serialization stream. More...
 
override void SetLoadListMode (bool enabled)
 Sets the load list mode for the list More...
 

Properties

bool IsReadOnly [getprotected set]
 Gets or sets a value indicating whether the list is readonly. More...
 
- Properties inherited from Csla.Core.ObservableBindingList< C >
virtual bool SupportsChangeNotificationCore [get]
 Gets a value indicating whether this object supports change notification. More...
 
bool AllowEdit [getprotected set]
 Gets or sets a value indicating whether data binding can automatically edit items in this collection. More...
 
bool AllowNew [getprotected set]
 Gets or sets a value indicating whether data binding can automatically add new items to this collection. More...
 
bool AllowRemove [getprotected set]
 Gets or sets a value indicating whether data binding can automatically remove items from this collection. More...
 
bool RaiseListChangedEvents [getset]
 Gets or sets a value indicating whether the collection should raise changed events. More...
 
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...
 
EventHandler< AddedNewEventArgs< T > > AddedNew
 Event raised when a new object has been added to the collection. More...
 
IDisposable SuppressListChangedEvents [get]
 Use this object to suppress ListChangedEvents for an entire code block. More...
 

Detailed Description

A readonly version of ObservableBindingList.

Template Parameters
CType of item contained in the list.

This is a subclass of ObservableBindingList that implements a readonly list, preventing adding and removing of items from the list. Use the IsReadOnly property to unlock the list for loading/unloading data.

Definition at line 28 of file ReadOnlyObservableBindingList.cs.

Constructor & Destructor Documentation

◆ ReadOnlyObservableBindingList()

Creates an instance of the object.

Definition at line 35 of file ReadOnlyObservableBindingList.cs.

Member Function Documentation

◆ OnCollectionChanged()

override void Csla.Core.ReadOnlyObservableBindingList< C >.OnCollectionChanged ( NotifyCollectionChangedEventArgs  e)
protected

Method invoked when collection is changed.

Parameters
eArguments

Definition at line 52 of file ReadOnlyObservableBindingList.cs.

◆ OnGetState()

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

Parameters
infoObject containing the data to serialize.

Definition at line 104 of file ReadOnlyObservableBindingList.cs.

◆ OnSetChildren()

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

Parameters
infoObject containing the data to serialize.
formatterReference to MobileFormatter instance. Use this to convert child references to/from reference id values.

Definition at line 134 of file ReadOnlyObservableBindingList.cs.

◆ OnSetState()

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

Parameters
infoObject containing the data to serialize.

Definition at line 117 of file ReadOnlyObservableBindingList.cs.

◆ SetLoadListMode()

override void Csla.Core.ReadOnlyObservableBindingList< C >.SetLoadListMode ( bool  enabled)
protected

Sets the LoadListMode for the collection

Parameters
enabledEnable or disable mode

Definition at line 87 of file ReadOnlyObservableBindingList.cs.

Property Documentation

◆ IsReadOnly

bool Csla.Core.ReadOnlyObservableBindingList< C >.IsReadOnly
getprotected set

Gets or sets a value indicating whether the list is readonly.

Subclasses can set this value to unlock the collection in order to alter the collection's data.

True indicates that the list is readonly.

Definition at line 71 of file ReadOnlyObservableBindingList.cs.