Csla.Windows.BindingSourceRefresh Class Reference

BindingSourceRefresh contains functionality for refreshing the data bound to controls on Host as well as a mechinism for catching data binding errors that occur in Host. More...

Inheritance diagram for Csla.Windows.BindingSourceRefresh:

Public Member Functions
	BindingSourceRefresh ()
	Constructor creates a new BindingSourceRefresh component then initialises all the different sub components.
	BindingSourceRefresh (IContainer container)
	Constructor creates a new BindingSourceRefresh component, adds the component to the container supplied before initialising all the different sub components.
bool	CanExtend (object? extendee)
	CanExtend() returns true if extendee is a binding source.
bool	GetReadValuesOnChange (BindingSource source)
	GetReadValuesOnChange() gets the value of the custom ReadValuesOnChange extender property added to extended controls. property added to extended controls.
void	SetReadValuesOnChange (BindingSource source, bool value)
	SetReadValuesOnChange() sets the value of the custom ReadValuesOnChange extender property added to extended controls.

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.

Properties
ContainerControl?	Host [get, set]
	Not in use - kept for backward compatibility.
bool	RefreshOnException [get, set]
	Forces the binding to re-read after an exception is thrown when changing the binding value.

Events
BindingErrorEventHandler?	BindingError = null
	BindingError event is raised when a data binding error occurs due to a exception.

Detailed Description

BindingSourceRefresh contains functionality for refreshing the data bound to controls on Host as well as a mechinism for catching data binding errors that occur in Host.

Windows Forms extender control that resolves the data refresh issue with data bound detail controls as discussed in Chapter 5.

Constructor & Destructor Documentation

BindingSourceRefresh() [1/2]

Csla.Windows.BindingSourceRefresh.BindingSourceRefresh ( )

inline

Constructor creates a new BindingSourceRefresh component then initialises all the different sub components.

BindingSourceRefresh() [2/2]

Csla.Windows.BindingSourceRefresh.BindingSourceRefresh ( IContainer container )

inline

Constructor creates a new BindingSourceRefresh component, adds the component to the container supplied before initialising all the different sub components.

Parameters

container

The container the component is to be added to.

Exceptions

ArgumentNullException

container is null.

Member Function Documentation

CanExtend()

bool Csla.Windows.BindingSourceRefresh.CanExtend ( object? extendee )

inline

CanExtend() returns true if extendee is a binding source.

Parameters

extendee

The control to be extended.

Returns

True if the control is a binding source, else false.

Dispose()

override void Csla.Windows.BindingSourceRefresh.Dispose ( bool disposing )

inlineprotected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

GetReadValuesOnChange()

bool Csla.Windows.BindingSourceRefresh.GetReadValuesOnChange ( BindingSource source )

inline

GetReadValuesOnChange() gets the value of the custom ReadValuesOnChange extender property added to extended controls. property added to extended controls.

Parameters

source

Control being extended.

Exceptions

ArgumentNullException

source is null.

SetReadValuesOnChange()

void Csla.Windows.BindingSourceRefresh.SetReadValuesOnChange ( BindingSource source, bool value )

inline

SetReadValuesOnChange() sets the value of the custom ReadValuesOnChange extender property added to extended controls.

Parameters

source	Control being extended.
value	New value of property.

Exceptions

ArgumentNullException

source is null.

Property Documentation

Host

ContainerControl? Csla.Windows.BindingSourceRefresh.Host

getset

Not in use - kept for backward compatibility.

RefreshOnException

bool Csla.Windows.BindingSourceRefresh.RefreshOnException

getset

Forces the binding to re-read after an exception is thrown when changing the binding value.

Event Documentation

BindingError

BindingErrorEventHandler? Csla.Windows.BindingSourceRefresh.BindingError = null

BindingError event is raised when a data binding error occurs due to a exception.

---

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

• csla/Source/Csla.Windows/BindingSourceRefresh.cs