Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartRadRibbonWindowForm Copy to Clipboard
Parent classes:
Telerik.WinControls.UI.RadRibbonForm
Consultingwerk.Forms.Telerik.BaseRadRibbonForm
Consultingwerk.SmartComponents.Base.SmartRadRibbonWindowForm

Inherits: Consultingwerk.Forms.Telerik.BaseRadRibbonForm
Implements: IBaseForm, Consultingwerk.SmartComponents.Interfaces.ISmartWindowForm

File:SmartRadRibbonWindowForm
Purpose:Base class for SmartComponent Library Forms based on
Telerik RadForm
Author(s):Marko Rueterbories / Consultingwerk Ltd.
Created:Wed Jun 17 08:58:39 CEST 2009

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ActivateLinks (Control) Activates the Links between the active control and the SmartToolbarController
ActivateSmartControl (Control) Marks a SmartViewerControl or SmartBrowserControl as Active
DeactivateHandler (Object, EventArgs) Event handler for the Deactivate event
DeactivateTimerTick (Object, EventArgs) Handles the Tick of the Deactivate Timer component
Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters () Returns a List of Data Adapter instances in the Form
Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter) Returns a List of Data Adapter instances in the Form
GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter) Add linked SmartDataAdapter instances to a List
Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl GetToolbar () Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
LockForm () Locks the Form
OnActiveSmartControlChanged (EventArgs) Raises the ActiveSmartControlChanged event
OnExternalDataSourceChanged (EventArgs) Raises the ExternalDataSourceChanged event
OnExternalNavigationTargetChanged (EventArgs) Raises the OnExternalNavigationTargetChanged
OnFormClosing (FormClosingEventArgs) Checks whether it is ok to close the form. If not the FormClosing process is canceled.
OnLoad (EventArgs) Raises the Load event
OnPrimaryDataSourceChanged (EventArgs) Raises the PrimaryDataSourceChanged event
OnPrimaryDataTargetChanged (EventArgs) Raises the PrimaryDataTargetChanged event
OnPrimaryNavigationSourceChanged (EventArgs) Raises the PrimaryNavigationSourceChanged
OnSmartToolbarControllerChanged () Internal event handler
Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose () Shows the Prompt to save pending transactions to the backend while closing the Form
LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason) Recursively ask all Controls implementing the ICheckOkToClose Interface whether it is ok to close the form.
LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical) Recursively checks all contained controls to save changes on Deactivate of the Form

Top Constructor Summary
Options Name Purpose
SmartRadRibbonWindowForm () Constructor for the SmartRadRibbonWindowForm class

Top Event Summary
Options Name Purpose
ActiveSmartControlChanged DELEGATE System.EventHandler Raised whenever the ActiveSmartSmartControl property has changed
ExternalDataSourceChanged DELEGATE System.EventHandler Raised when the ExternalDataSource property changes
ExternalNavigationTargetChanged (Object, EventArgs) Raised when the ExternalNavigationSource property changes
PrimaryDataSourceChanged DELEGATE System.EventHandler Raised when the PrimaryDataSource property changes
PrimaryDataTargetChanged DELEGATE System.EventHandler Raised when the PrimaryDataTarget property changes
PrimaryNavigationSourceChanged (Object, EventArgs) Raised when the PrimaryNavigationSource property changes

Top Property Summary
Options Name Purpose
System.Windows.Forms.Control ActiveSmartControl
Consultingwerk.SmartComponents.Interfaces.ISmartDataSource ExternalDataSource
Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget
Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource
Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget
Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource
LOGICAL PromptForSaveOnApplicationLeave
LOGICAL PromptForSaveOnFormDeactivate


Method Detail
Top

ActivateLinks (Control)
Purpose: Activates the Links between the active control and the
SmartToolbarController
Notes: When the ActiveControl is a read-only Browse, we attempt to activate
the TableIO Link on another Data-Target of the Browsers SmartDataAdapter
That could be a Viewer with is linked to the same adapter

Parameters:
poActiveControl System.Windows.Forms.Control
The Control where the Links should be activated
Top

ActivateSmartControl (Control)
Purpose: Marks a SmartViewerControl or SmartBrowserControl as Active
Notes:

Parameters:
poControl System.Windows.Forms.Control
The reference to the Control that has become active
Top

DeactivateHandler (Object, EventArgs)
Purpose: Event handler for the Deactivate event
Notes: Enables the times for the PromptForSaveOnFormDeactivate or
PromptForSaveOnApplicationLeave. Used to be OnDeactivate method
override, but that did lead to crashes at some customers on 11.1.0.005

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

DeactivateTimerTick (Object, EventArgs)
Purpose: Handles the Tick of the Deactivate Timer component
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters ()
Purpose: Returns a List of Data Adapter instances in the Form
Notes: Returns the PrimaryDataTarget (when that's a Data Adapter) and
the PrimaryDataSource as well as all their DataTarget instances

Returns Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The List of Data Adapter instances
Top

Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter)
Purpose: Returns a List of Data Adapter instances in the Form
Notes: Returns the PrimaryDataTarget (when that's a Data Adapter) and
the PrimaryDataSource or the poStart SmartDataAdapter instance
as well as all their DataTarget instances

Parameters:
poStart Consultingwerk.SmartComponents.Base.SmartDataAdapter
An optional reference to a SmartDataAdapter to use as the starting point
Returns Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The List of Data Adapter instances
Top

GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter)
Purpose: Add linked SmartDataAdapter instances to a List
Notes: Used by GetLinkedDataAdapters (poStart)

Parameters:
poStart Consultingwerk.SmartComponents.Base.SmartDataAdapter
The reference to a SmartDataAdapter to use as the starting point
poList Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The list of SmartDataAdapters to add to
Top

Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl GetToolbar ()
Purpose: Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl
The reference to the ISmartToolbarControl of the ISmartWindowForm
Top

LockForm ()
Purpose: Locks the Form
Notes: Used by the ClientLockController. Calls into all Toolbars and
all ILockableControls

Top

OnActiveSmartControlChanged (EventArgs)
Purpose: Raises the ActiveSmartControlChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

OnExternalDataSourceChanged (EventArgs)
Purpose: Raises the ExternalDataSourceChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

OnExternalNavigationTargetChanged (EventArgs)
Purpose: Raises the OnExternalNavigationTargetChanged
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

OnFormClosing (FormClosingEventArgs)
Purpose: Checks whether it is ok to close the form. If not the FormClosing
process is canceled.
Notes:

Parameters:
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
Top

OnLoad (EventArgs)
Purpose: Raises the Load event
Notes: Passes though the ExternalDataSource to the PrimaryDataTarget

Parameters:
e System.EventArgs
The FormClosingEventArgs with the data for this event
Top

OnPrimaryDataSourceChanged (EventArgs)
Purpose: Raises the PrimaryDataSourceChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

OnPrimaryDataTargetChanged (EventArgs)
Purpose: Raises the PrimaryDataTargetChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

OnPrimaryNavigationSourceChanged (EventArgs)
Purpose: Raises the PrimaryNavigationSourceChanged
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

OnSmartToolbarControllerChanged ()
Purpose: Internal event handler
Notes: Invoked when the SmartToolbarController property changes

Top

Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose ()
Purpose: Shows the Prompt to save pending transactions to the backend while
closing the Form
Notes: Can be overridden by customers to change behavior

Returns Consultingwerk.Framework.Enum.DialogResultEnum
The DialogResultEnum value indicating "Yes" to save changes, "No" to not save changes and "Cancel" to not close the Form
Top

LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason)
Purpose: Recursively ask all Controls implementing the ICheckOkToClose Interface
whether it is ok to close the form.
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The System.Windows.Forms.Control+ControlCollection Collection of Controls to iterate
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form.
poCloseReason System.Windows.Forms.CloseReason
The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason who closes the form.
Returns LOGICAL
Logical value indicating if the Form can be closed or not.
Top

LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical)
Purpose: Recursively checks all contained controls to save changes on
Deactivate of the Form
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The System.Windows.Forms.Control+ControlCollection Collection of Controls to iterate
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form.
Returns LOGICAL
Logical value indicating if it's o.k. to move to the Activated window


Constructor Detail
Top

SmartRadRibbonWindowForm ()
Purpose: Constructor for the SmartRadRibbonWindowForm class
Notes:



Event Detail
Top

ActiveSmartControlChanged DELEGATE System.EventHandler
Purpose: Raised whenever the ActiveSmartSmartControl property has changed
Notes:

Delegate: System.EventHandler
Top

ExternalDataSourceChanged DELEGATE System.EventHandler
Purpose: Raised when the ExternalDataSource property changes
Notes:

Delegate: System.EventHandler
Top

ExternalNavigationTargetChanged (Object, EventArgs)
Purpose: Raised when the ExternalNavigationSource property changes
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the OnExternalNavigationTargetChanged event
e System.EventArgs
The System.EventArgs with the data for the event
Top

PrimaryDataSourceChanged DELEGATE System.EventHandler
Purpose: Raised when the PrimaryDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PrimaryDataTargetChanged DELEGATE System.EventHandler
Purpose: Raised when the PrimaryDataTarget property changes
Notes:

Delegate: System.EventHandler
Top

PrimaryNavigationSourceChanged (Object, EventArgs)
Purpose: Raised when the PrimaryNavigationSource property changes
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the PrimaryNavigationSourceChanged event
e System.EventArgs
The System.EventArgs with the data for the event


Property Detail
Top

System.Windows.Forms.Control ActiveSmartControl

Returns System.Windows.Forms.Control
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataSource ExternalDataSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

LOGICAL PromptForSaveOnApplicationLeave

Returns LOGICAL
Top

LOGICAL PromptForSaveOnFormDeactivate

Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:23:13