CSLA.NET 6.0.0
CSLA .NET is a software development framework that helps you build a reusable, maintainable object-oriented business layer for your app.
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. More...
 
 BindingSourceRefresh (IContainer container)
 Constructor creates a new BindingSourceRefresh component, adds the component to the container supplied before initialising all the different sub components. More...
 
bool CanExtend (object extendee)
 CanExtend() returns true if extendee is a binding source. More...
 
bool GetReadValuesOnChange (BindingSource source)
 GetReadValuesOnChange() gets the value of the custom ReadValuesOnChange extender property added to extended controls. More...
 
void SetReadValuesOnChange (BindingSource source, bool value)
 SetReadValuesOnChange() sets the value of the custom ReadValuesOnChange extender property added to extended controls. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Properties

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

Events

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

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.

Definition at line 29 of file BindingSourceRefresh.cs.

Constructor & Destructor Documentation

◆ BindingSourceRefresh() [1/2]

Csla.Windows.BindingSourceRefresh.BindingSourceRefresh ( )

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

Definition at line 44 of file BindingSourceRefresh.cs.

◆ BindingSourceRefresh() [2/2]

Csla.Windows.BindingSourceRefresh.BindingSourceRefresh ( IContainer  container)

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

Parameters
containerThe container the component is to be added to.

Definition at line 52 of file BindingSourceRefresh.cs.

Member Function Documentation

◆ CanExtend()

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

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

Parameters
extendeeThe control to be extended.
Returns
True if the control is a binding source, else false.

Definition at line 94 of file BindingSourceRefresh.cs.

◆ Dispose()

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

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

Definition at line 68 of file BindingSourceRefresh.cs.

◆ GetReadValuesOnChange()

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

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

property added to extended controls.

Parameters
sourceControl being extended.

Definition at line 104 of file BindingSourceRefresh.cs.

◆ SetReadValuesOnChange()

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

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

Parameters
sourceControl being extended.
valueNew value of property.

Definition at line 120 of file BindingSourceRefresh.cs.

Property Documentation

◆ Host

ContainerControl Csla.Windows.BindingSourceRefresh.Host
getset

Not in use - kept for backward compatibility

Definition at line 141 of file BindingSourceRefresh.cs.

◆ RefreshOnException

bool Csla.Windows.BindingSourceRefresh.RefreshOnException
getset

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

Definition at line 148 of file BindingSourceRefresh.cs.

Event Documentation

◆ BindingError

BindingErrorEventHandler Csla.Windows.BindingSourceRefresh.BindingError = null

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

Definition at line 38 of file BindingSourceRefresh.cs.