Extender control providing automation around data binding to CSLA .NET business objects. More...

Inheritance diagram for Csla.Windows.CslaActionExtender:

Public Member Functions
	CslaActionExtender (IContainer container)
	Creates an instance of the type.
CslaFormAction	GetActionType (Control ctl)
	Gets the action type.
void	SetActionType (Control ctl, CslaFormAction value)
	Sets the action type.
PostSaveActionType	GetPostSaveAction (Control ctl)
	Gets the post save action.
void	SetPostSaveAction (Control ctl, PostSaveActionType value)
	Sets the post save action.
bool	GetRebindAfterSave (Control ctl)
	Gets the rebind after save value.
void	SetRebindAfterSave (Control ctl, bool value)
	Sets the rebind after save value.
bool	GetDisableWhenUseless (Control ctl)
	Gets the disable when useless value.
void	SetDisableWhenUseless (Control ctl, bool value)
	Sets the disable when useless value.
string	GetCommandName (Control ctl)
	Gets the command name value.
void	SetCommandName (Control ctl, string value)
	Sets the command name value.
void	ResetActionBehaviors (ISavable? objectToBind)
	Resets all action behaviors.

Protected Member Functions
virtual void	OnClicking (CslaActionCancelEventArgs e)
	Raises the Clicking event.
virtual void	OnClicked (CslaActionEventArgs e)
	Raises the Clicked event.
virtual void	OnErrorEncountered (ErrorEncounteredEventArgs e)
	Raises the ErrorEncountered event.
virtual void	OnSetForNew (CslaActionEventArgs e)
	Raises the SetForNew event.
virtual void	OnBusinessObjectInvalid (CslaActionEventArgs e)
	Raises the BusinessObjectInvalid event.
virtual void	OnHasBrokenRules (HasBrokenRulesEventArgs e)
	Raises the HasBrokenRules event.
virtual void	OnObjectSaving (CslaActionCancelEventArgs e)
	Raises the ObjectSaving event.
virtual void	OnObjectSaved (CslaActionEventArgs e)
	Raises the ObjectSaved event.
void	OnClick (object? sender, EventArgs e)
	Method invoked when the target control is clicked.

Properties
object?	DataSource `[get, set]`
	Gets or sets a reference to the data source object.
bool	AutoShowBrokenRules = true `[get, set]`
	Gets or sets a value indicating whether to automatically show broken rules.
bool	WarnIfCloseOnDirty = true `[get, set]`
	Gets or sets a value indicating whether to warn the user on close when the object is dirty.
string	DirtyWarningMessage = Resources.ActionExtenderDirtyWarningMessagePropertyDefault `[get, set]`
	Gets or sets the message shown to the user in a close on dirty warning.
bool	WarnOnCancel = false `[get, set]`
	Gets or sets a value indicating whether to warn the user on cancel.
string	WarnOnCancelMessage = Resources.ActionExtenderWarnOnCancelMessagePropertyDefault `[get, set]`
	Gets or sets the message shown to the user in a warn on cancel.
string	ObjectIsValidMessage = Resources.ActionExtenderObjectIsValidMessagePropertyDefault `[get, set]`
	Gets or sets the message shown to the user when a button with a Validate ActionType is pressed when the object is valid.

Events
EventHandler< CslaActionCancelEventArgs >?	Clicking
	Event indicating the user is clicking on the Control.
EventHandler< CslaActionEventArgs >?	Clicked
	Event indicating the user clicked on the Control.
EventHandler< ErrorEncounteredEventArgs >?	ErrorEncountered
	Event indicating an error was encountered.
EventHandler< CslaActionEventArgs >?	SetForNew
	Event indicating the object is set for new.
EventHandler< CslaActionEventArgs >?	BusinessObjectInvalid
	Event indicating the business object is in an invalid state.
EventHandler< HasBrokenRulesEventArgs >?	HasBrokenRules
	Event indicating the business object has broken rules.
EventHandler< CslaActionCancelEventArgs >?	ObjectSaving
	Event indicating that the object is saving.
EventHandler< CslaActionEventArgs >?	ObjectSaved
	Event indicating that the object has been saved.

Detailed Description

Extender control providing automation around data binding to CSLA .NET business objects.

Constructor & Destructor Documentation

◆ CslaActionExtender()

Csla.Windows.CslaActionExtender.CslaActionExtender ( IContainer container )

inline

Creates an instance of the type.

Parameters

container Container for the component.

Exceptions

ArgumentNullException container is null.

Member Function Documentation

◆ GetActionType()

CslaFormAction Csla.Windows.CslaActionExtender.GetActionType ( Control ctl )

inline

Gets the action type.

Parameters

ctl	Reference to Control.

Exceptions

ArgumentNullException ctl is null.

◆ GetCommandName()

string Csla.Windows.CslaActionExtender.GetCommandName ( Control ctl )

inline

Gets the command name value.

Parameters

ctl	Reference to Control.

Exceptions

ArgumentNullException ctl is null.

◆ GetDisableWhenUseless()

bool Csla.Windows.CslaActionExtender.GetDisableWhenUseless ( Control ctl )

inline

Gets the disable when useless value.

Parameters

ctl	Reference to Control.

Exceptions

ArgumentNullException ctl is null.

◆ GetPostSaveAction()

PostSaveActionType Csla.Windows.CslaActionExtender.GetPostSaveAction ( Control ctl )

inline

Gets the post save action.

Parameters

ctl	Reference to Control.

Exceptions

ArgumentNullException ctl is null.

◆ GetRebindAfterSave()

bool Csla.Windows.CslaActionExtender.GetRebindAfterSave ( Control ctl )

inline

Gets the rebind after save value.

Parameters

ctl	Reference to Control.

Exceptions

ArgumentNullException ctl is null.

◆ OnBusinessObjectInvalid()

virtual void Csla.Windows.CslaActionExtender.OnBusinessObjectInvalid ( CslaActionEventArgs e )

inlineprotectedvirtual

Raises the BusinessObjectInvalid event.

Parameters

e	Event arguments.

◆ OnClick()

void Csla.Windows.CslaActionExtender.OnClick	(	object?	sender,
		EventArgs	e )

inlineprotected

Method invoked when the target control is clicked.

Parameters

sender	Object originating action.
e	Arguments.

◆ OnClicked()

virtual void Csla.Windows.CslaActionExtender.OnClicked ( CslaActionEventArgs e )

inlineprotectedvirtual

Raises the Clicked event.

Parameters

e	Event arguments.

◆ OnClicking()

virtual void Csla.Windows.CslaActionExtender.OnClicking ( CslaActionCancelEventArgs e )

inlineprotectedvirtual

Raises the Clicking event.

Parameters

e	Event arguments.

◆ OnErrorEncountered()

virtual void Csla.Windows.CslaActionExtender.OnErrorEncountered ( ErrorEncounteredEventArgs e )

inlineprotectedvirtual

Raises the ErrorEncountered event.

Parameters

e	Event arguments.

◆ OnHasBrokenRules()

virtual void Csla.Windows.CslaActionExtender.OnHasBrokenRules ( HasBrokenRulesEventArgs e )

inlineprotectedvirtual

Raises the HasBrokenRules event.

Parameters

e	Event arguments.

◆ OnObjectSaved()

virtual void Csla.Windows.CslaActionExtender.OnObjectSaved ( CslaActionEventArgs e )

inlineprotectedvirtual

Raises the ObjectSaved event.

Parameters

e	Event arguments.

◆ OnObjectSaving()

virtual void Csla.Windows.CslaActionExtender.OnObjectSaving ( CslaActionCancelEventArgs e )

inlineprotectedvirtual

Raises the ObjectSaving event.

Parameters

e	Event arguments.

◆ OnSetForNew()

virtual void Csla.Windows.CslaActionExtender.OnSetForNew ( CslaActionEventArgs e )

inlineprotectedvirtual

Raises the SetForNew event.

Parameters

e	Event arguments.

◆ ResetActionBehaviors()

void Csla.Windows.CslaActionExtender.ResetActionBehaviors ( ISavable? objectToBind )

inline

Resets all action behaviors.

Parameters

objectToBind Target object.

◆ SetActionType()

void Csla.Windows.CslaActionExtender.SetActionType	(	Control	ctl,
		CslaFormAction	value )

inline

Sets the action type.

Parameters

ctl	Reference to Control.
value	Value for property.

Exceptions

ArgumentNullException ctl is null.

◆ SetCommandName()

void Csla.Windows.CslaActionExtender.SetCommandName	(	Control	ctl,
		string	value )

inline

Sets the command name value.

Parameters

ctl	Reference to Control.
value	Value for property.

Exceptions

ArgumentNullException ctl or value is null.

◆ SetDisableWhenUseless()

void Csla.Windows.CslaActionExtender.SetDisableWhenUseless	(	Control	ctl,
		bool	value )

inline

Sets the disable when useless value.

Parameters

ctl	Reference to Control.
value	Value for property.

Exceptions

ArgumentNullException ctl is null.

◆ SetPostSaveAction()

void Csla.Windows.CslaActionExtender.SetPostSaveAction	(	Control	ctl,
		PostSaveActionType	value )

inline

Sets the post save action.

Parameters

ctl	Reference to Control.
value	Value for property.

Exceptions

ArgumentNullException ctl is null.

◆ SetRebindAfterSave()

void Csla.Windows.CslaActionExtender.SetRebindAfterSave	(	Control	ctl,
		bool	value )

inline

Sets the rebind after save value.

Parameters

ctl	Reference to Control.
value	Value for property.

Exceptions

ArgumentNullException ctl is null.

Property Documentation

◆ AutoShowBrokenRules

bool Csla.Windows.CslaActionExtender.AutoShowBrokenRules = true

getset

Gets or sets a value indicating whether to automatically show broken rules.

◆ DataSource

object? Csla.Windows.CslaActionExtender.DataSource

getset

Gets or sets a reference to the data source object.

◆ DirtyWarningMessage

string Csla.Windows.CslaActionExtender.DirtyWarningMessage = Resources.ActionExtenderDirtyWarningMessagePropertyDefault

getset

Gets or sets the message shown to the user in a close on dirty warning.

◆ ObjectIsValidMessage

string Csla.Windows.CslaActionExtender.ObjectIsValidMessage = Resources.ActionExtenderObjectIsValidMessagePropertyDefault

getset

Gets or sets the message shown to the user when a button with a Validate ActionType is pressed when the object is valid.

◆ WarnIfCloseOnDirty

bool Csla.Windows.CslaActionExtender.WarnIfCloseOnDirty = true

getset

Gets or sets a value indicating whether to warn the user on close when the object is dirty.

◆ WarnOnCancel

bool Csla.Windows.CslaActionExtender.WarnOnCancel = false

getset

Gets or sets a value indicating whether to warn the user on cancel.

◆ WarnOnCancelMessage

string Csla.Windows.CslaActionExtender.WarnOnCancelMessage = Resources.ActionExtenderWarnOnCancelMessagePropertyDefault

getset

Gets or sets the message shown to the user in a warn on cancel.

Event Documentation

◆ BusinessObjectInvalid

EventHandler<CslaActionEventArgs>? Csla.Windows.CslaActionExtender.BusinessObjectInvalid

Event indicating the business object is in an invalid state.

◆ Clicked

EventHandler<CslaActionEventArgs>? Csla.Windows.CslaActionExtender.Clicked

Event indicating the user clicked on the Control.

◆ Clicking

EventHandler<CslaActionCancelEventArgs>? Csla.Windows.CslaActionExtender.Clicking

Event indicating the user is clicking on the Control.

◆ ErrorEncountered

EventHandler<ErrorEncounteredEventArgs>? Csla.Windows.CslaActionExtender.ErrorEncountered

Event indicating an error was encountered.

◆ HasBrokenRules

EventHandler<HasBrokenRulesEventArgs>? Csla.Windows.CslaActionExtender.HasBrokenRules

Event indicating the business object has broken rules.

◆ ObjectSaved

EventHandler<CslaActionEventArgs>? Csla.Windows.CslaActionExtender.ObjectSaved

Event indicating that the object has been saved.

◆ ObjectSaving

EventHandler<CslaActionCancelEventArgs>? Csla.Windows.CslaActionExtender.ObjectSaving

Event indicating that the object is saving.

◆ SetForNew

EventHandler<CslaActionEventArgs>? Csla.Windows.CslaActionExtender.SetForNew

Event indicating the object is set for new.

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

csla/Source/Csla.Windows/CslaActionExtender.cs

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ CslaActionExtender()

Member Function Documentation

◆ GetActionType()

◆ GetCommandName()

◆ GetDisableWhenUseless()

◆ GetPostSaveAction()

◆ GetRebindAfterSave()

◆ OnBusinessObjectInvalid()

◆ OnClick()

◆ OnClicked()

◆ OnClicking()

◆ OnErrorEncountered()

◆ OnHasBrokenRules()

◆ OnObjectSaved()

◆ OnObjectSaving()

◆ OnSetForNew()

◆ ResetActionBehaviors()

◆ SetActionType()

◆ SetCommandName()

◆ SetDisableWhenUseless()

◆ SetPostSaveAction()

◆ SetRebindAfterSave()

Property Documentation

◆ AutoShowBrokenRules

◆ DataSource

◆ DirtyWarningMessage

◆ ObjectIsValidMessage

◆ WarnIfCloseOnDirty

◆ WarnOnCancel

◆ WarnOnCancelMessage

Event Documentation

◆ BusinessObjectInvalid

◆ Clicked

◆ Clicking

◆ ErrorEncountered

◆ HasBrokenRules

◆ ObjectSaved

◆ ObjectSaving

◆ SetForNew