Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartUiControlHandlerBase Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartComponents.Base.SmartUiControlHandlerBase

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.SmartComponents.Base.SmartFormUiControlHandler Consultingwerk.SmartComponents.Base.SmartGridUiControlHandler Consultingwerk.SmartComponents.Base.SmartToolbarUiControlHandler Consultingwerk.SmartComponents.Base.SmartViewerUiControlHandler
ABSTRACT


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



Top Method Summary
Options Name Purpose
ActivateParentTabPages (Control) Activates the tab pages that host the given control
ActivateTabFolderPage (ActivateTabFolderPageUiAction, Object) Activates a tab folder page
ApplyLookupDefinition (SmartBusinessEntityLookup, SmartBusinessEntityLookupDescriptor) Applies a lookup definition to a SmartBusinessEntityLookup
AssignScreenValuesProperties (EventHandlerParameter) Assigns the properties of the EventHandlerParameter that describe the screen values dataset built by GetScreenValuesDataset
BeforeUpdateLookupDefinition (SmartBusinessEntityLookup) Invoked before an UpdateLookupDefinitionUiAction changes the lookup definition of a SmartBusinessEntityLookup
CallMethod (MethodCallParameter) Executes the method referenced by the MethodCallParameter instance
DownloadFile (DownloadFileUiAction, Object) Handles DownloadFileUiActions by retrieving the file content from the DownloadFileBusinessTask and prompting the user to save it via a SaveFileDialog, then optionally opening it
EnableDisableTabPage (EnableDisableTabPageUiAction, Object) Enables or disables a tab page
EnableToolbarButton (EnableToolbarButtonUiAction, Object) Handles EnableToolbarButtonUiActions
Consultingwerk.Windows.Controls.DynamicTreeViewControl FindDynamicTreeViewControl (character) Returns the tree view (MetaTreeView instance) a RefreshTreeViewUiAction addresses
Consultingwerk.Windows.Controls.DynamicTreeViewControl FindDynamicTreeViewControl (Control, character) Returns the tree view (MetaTreeView instance) hosted by the given container control
A System.Windows.Forms.Form FindForm () Finds the form associated with the control
A Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource () Gets the data source
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget () Returns the TableIO target of a SetTableIoActionDisabledUiAction without a TargetInstanceName
HANDLE GetScreenValuesDataset () Gets the screen values dataset
System.Windows.Forms.Control GetViewerField (character) Retrieves the control associated with the field
HandleCancelEvent (Object, logical) Handles cancel event by setting Cancel flag on event arguments
Consultingwerk.CommonUi.UiControl HandleServerEvent (EventHandlerParameter, character, character, Object, Object) Handles server-side event with Questions/InputPrompts loop
HandleUiAction (IUiAction, Object) Handles UiActions
HandleUiControl (UiControl, handle, Object) Handles UiControl by applying changes back to the control
LaunchForm (LaunchFormUiAction, Object) Launches a Form requested by an SSEH-returned LaunchFormUiAction.
OpenQuery (OpenQueryUiAction, Object) Opens a query
OpenWebPage (OpenWebPageUiAction, Object) Opens a web page
PerformTableIoAction (ISmartTableIOTarget, TableIoActionEnum) Performs a TableIoAction on a viewer or an updatable grid
RefreshData (RefreshDataUiAction, Object) Refreshes the data of a data-source (SmartBusinessEntityAdapter) instance by calling its RefreshData () method
RefreshTreeView (RefreshTreeViewUiAction, Object) Reloads the tree structure of a tree view (MetaTreeView instance) by calling its RefreshTree () method
SetCharacterProperty (SetCharacterPropertyUiAction, Object) Sets a character property on the sender object
SetStatusBarText (SetStatusBarTextUiAction, Object) Sets the StatusBar Text
SetTableIoActionDisabled (SetTableIoActionDisabledUiAction, Object) Handles SetTableIoActionDisabledUiActions by permanently disabling (or enabling again) TableIO tools for a viewer or grid
SetUpdateState (EventHandlerParameter) Sets the UpdateState in the EventHandlerParameter's EventContext
ShowInputPrompts (ListInputPrompt) Shows the input prompts
ShowMessages (ListValidationMessage) Shows the messages
ShowNotifications (ListNotification) Shows the notifications via UltraDesktopAlert
ShowQuestions (ListQuestion) Shows the questions
StoreLruEntry (StoreLruEntryUiAction, Object) Handles StoreLruEntryUiActions by storing the current record of the active DynamicForm in the Ribbon LRU list
A TableIoAction (TableIoUiAction, Object) Handles TableIoUiActions
TableIoActionOnTarget (TableIoUiAction) Handles a TableIoUiAction with a TargetInstanceName by performing the TableIoAction on that viewer or updatable grid of the Form
UpdateFormTitle (UpdateFormTitleUiAction, Object) Handles UpdateFormTitleUiActions by setting the title of the Form that raised the event
UpdateLookupDefinition (UpdateLookupDefinitionUiAction, Object) Handles UpdateLookupDefinitionUiActions by applying the lookup definition to the lookup field of the viewer

Top Constructor Summary
Options Name Purpose
SmartUiControlHandlerBase (Component) Constructor for the SmartUiControlHandlerBase class

Top Property Summary
Options Name Purpose
A Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
A Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl SmartToolbarControl


Method Detail
Top

ActivateParentTabPages (Control)
Purpose: Activates the tab pages that host the given control
Notes: SCL-6097. Selects the tab of every UltraTabPageControl in the
parent chain, so that a control on a nested tab folder becomes
visible as well

Parameters:
poControl System.Windows.Forms.Control
The control to make visible
Top

ActivateTabFolderPage (ActivateTabFolderPageUiAction, Object)
Purpose: Activates a tab folder page
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.ActivateTabFolderPageUiAction
The ActivateTabFolderPageUiAction with information about the tab folder page
sender Progress.Lang.Object
The sender of the event
Top

ApplyLookupDefinition (SmartBusinessEntityLookup, SmartBusinessEntityLookupDescriptor)
Purpose: Applies a lookup definition to a SmartBusinessEntityLookup
Notes: SCL-6066. The cached SmartBusinessEntityAdapter of the lookup
belongs to the previous definition and is discarded. The key value
bound to the lookup is not changed

Parameters:
poLookup Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityLookup
The SmartBusinessEntityLookup to apply the definition to
poLookupDescriptor Consultingwerk.Framework.RepositoryServices.SmartBusinessEntityLookupDescriptor
The lookup definition to apply
Top

AssignScreenValuesProperties (EventHandlerParameter)
Purpose: Assigns the properties of the EventHandlerParameter that describe
the screen values dataset built by GetScreenValuesDataset
Notes: SCL-6087 - called by HandleServerEvent after GetScreenValuesDataset.
Overridden by the SmartGridUiControlHandler to pass the
SelectedRowCount and the ActiveRowKey

Parameters:
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to assign the properties of
Top

BeforeUpdateLookupDefinition (SmartBusinessEntityLookup)
Purpose: Invoked before an UpdateLookupDefinitionUiAction changes the
lookup definition of a SmartBusinessEntityLookup
Notes: SCL-6066. Allows subclasses to remember the previous definition
(SmartViewerUiControlHandler restores it when the update is cancelled)

Parameters:
poLookup Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityLookup
The SmartBusinessEntityLookup whose definition is about to change
Top

CallMethod (MethodCallParameter)
Purpose: Executes the method referenced by the MethodCallParameter instance
Notes:

Parameters:
poMethodCallParameter Consultingwerk.CommonUi.MethodCallParameter
The reference to the MethodCallParameter instance
Top

DownloadFile (DownloadFileUiAction, Object)
Purpose: Handles DownloadFileUiActions by retrieving the file content
from the DownloadFileBusinessTask and prompting the user to
save it via a SaveFileDialog, then optionally opening it
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.DownloadFileUiAction
The DownloadFileUiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

EnableDisableTabPage (EnableDisableTabPageUiAction, Object)
Purpose: Enables or disables a tab page
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.EnableDisableTabPageUiAction
The EnableDisableTabPageUiAction with information about the tab folder and page
sender Progress.Lang.Object
The sender of the event
Top

EnableToolbarButton (EnableToolbarButtonUiAction, Object)
Purpose: Handles EnableToolbarButtonUiActions
Notes: Enabled ? leaves the enabled state unchanged. SCL-6175: sets the
Caption and the ToolTip of the tool (? = unchanged) when the
toolbar implements ISupportsToolCaption

Parameters:
poUiAction Consultingwerk.CommonUi.EnableToolbarButtonUiAction
The EnableToolbarButtonUiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

Consultingwerk.Windows.Controls.DynamicTreeViewControl FindDynamicTreeViewControl (character)
Purpose: Returns the tree view (MetaTreeView instance) a
RefreshTreeViewUiAction addresses
Notes: SCL-5861. A named instance is looked up in the component that
raised the event (a viewer holding the tree view) first and then
on the form, so that the tree view of the raising viewer wins
over a same-named instance elsewhere on the form. A blank
instance name takes the single tree view of the raising
component, and falls back to the first tree view of the form -
the way ActivateTabFolderPage resolves its tab folder

Parameters:
pcInstanceName CHARACTER
The repository instance name of the tree view, or an empty value
Returns Consultingwerk.Windows.Controls.DynamicTreeViewControl
The reference to the DynamicTreeViewControl or the unknown value
Top

Consultingwerk.Windows.Controls.DynamicTreeViewControl FindDynamicTreeViewControl (Control, character)
Purpose: Returns the tree view (MetaTreeView instance) hosted by the
given container control
Notes: SCL-5861. See FindDynamicTreeViewControl (pcInstanceName). The
controls are collected as System.Windows.Forms.Control and
filtered with type-of, as the ABL class of the tree view control
is not addressable through Progress.Util.TypeHelper

Parameters:
poContainer System.Windows.Forms.Control
The container control to search
pcInstanceName CHARACTER
The repository instance name of the tree view, or an empty value
Returns Consultingwerk.Windows.Controls.DynamicTreeViewControl
The reference to the DynamicTreeViewControl or the unknown value
Top

System.Windows.Forms.Form FindForm ()
Purpose: Finds the form associated with the control
Notes:

Returns System.Windows.Forms.Form
The form associated with the control
Top

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource ()
Purpose: Gets the data source
Notes:

Returns Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The data source
Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget GetDefaultTableIOTarget ()
Purpose: Returns the TableIO target of a SetTableIoActionDisabledUiAction
without a TargetInstanceName
Notes: SCL-6176. The active TableIO target of the toolbar; the viewer and
the grid UI control handlers return their viewer or grid

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The ISmartTableIOTarget or ? when there is none
Top

HANDLE GetScreenValuesDataset ()
Purpose: Gets the screen values dataset
Notes: SCL-6179 - returns the unknown value when the component has no
data source with a ProDataset (e.g. an unbound filter viewer).
The server-side event handler then receives no screen values,
like for the server-side events of the Form

Returns HANDLE
The screen values dataset or the unknown value
Top

System.Windows.Forms.Control GetViewerField (character)
Purpose: Retrieves the control associated with the field
Notes: Default implementation returns ? for UI controls that don't
have viewer fields (e.g., grids, toolbars)

Parameters:
pcFieldName CHARACTER
The name of the field
Returns System.Windows.Forms.Control
The control associated with the field
Top

HandleCancelEvent (Object, logical)
Purpose: Handles cancel event by setting Cancel flag on event arguments
Notes:

Parameters:
e Progress.Lang.Object
The event arguments
plCancel LOGICAL
The cancel flag
Top

Consultingwerk.CommonUi.UiControl HandleServerEvent (EventHandlerParameter, character, character, Object, Object)
Purpose: Handles server-side event with Questions/InputPrompts loop
Notes: Common logic extracted from SmartViewerControl.HandleServerEvent
and SmartToolbarServerSideEventHandler.HandleServerEvent
Calls HandleUiControl within the loop when there are unanswered questions

Parameters:
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter
pcTaskName CHARACTER
The task name
pcMethodName CHARACTER
The method name
sender Progress.Lang.Object
The sender of the event
e Progress.Lang.Object
The event arguments
Returns Consultingwerk.CommonUi.UiControl
The UiControl returned from InvokeTask2
Top

HandleUiAction (IUiAction, Object)
Purpose: Handles UiActions
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.IUiAction
The UiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

HandleUiControl (UiControl, handle, Object)
Purpose: Handles UiControl by applying changes back to the control
Notes: Implemented by subclasses to apply viewer/grid specific handling

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl to handle
phDataset HANDLE
The handle of the dataset with screen values
sender Progress.Lang.Object
The sender of the event
Top

LaunchForm (LaunchFormUiAction, Object)
Purpose: Launches a Form requested by an SSEH-returned LaunchFormUiAction.
Notes: SCL-4516 - modal launches are dispatched through
SmartFormFactory:LaunchModalForm LaunchModalForm (introduced in SCL-5256) so
the FormParameter is forwarded to the Form via
BaseForm:SetFormParameter SetFormParameter and the FormResponse / DialogResult
are available to the caller via the returned FormResult.
Non-modal launches use SmartFormFactory:LaunchForm and assign
the FormParameter directly to the BaseForm before the Form
is shown.

Parameters:
poUiAction Consultingwerk.CommonUi.LaunchFormUiAction
The LaunchFormUiAction with the launch context
sender Progress.Lang.Object
The sender of the event (unused, kept for signature consistency)
Top

OpenQuery (OpenQueryUiAction, Object)
Purpose: Opens a query
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.OpenQueryUiAction
The OpenQueryUiAction with information about the datasource and query
sender Progress.Lang.Object
The sender of the event
Top

OpenWebPage (OpenWebPageUiAction, Object)
Purpose: Opens a web page
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.OpenWebPageUiAction
The OpenWebPageUiAction with information about the web page
sender Progress.Lang.Object
The sender of the event
Top

PerformTableIoAction (ISmartTableIOTarget, TableIoActionEnum)
Purpose: Performs a TableIoAction on a viewer or an updatable grid
Notes: SCL-6097. Other components are ignored

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
The SmartViewerControl or SmartUpdatableBrowser to perform the action on
poTableIoAction Consultingwerk.CommonUi.TableIoActionEnum
The TableIoAction to perform
Top

RefreshData (RefreshDataUiAction, Object)
Purpose: Refreshes the data of a data-source (SmartBusinessEntityAdapter)
instance by calling its RefreshData () method
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.RefreshDataUiAction
The RefreshDataUiAction with the name of the data-source instance to refresh
sender Progress.Lang.Object
The sender of the event
Top

RefreshTreeView (RefreshTreeViewUiAction, Object)
Purpose: Reloads the tree structure of a tree view (MetaTreeView
instance) by calling its RefreshTree () method
Notes: SCL-5861. The tree view types are referenced fully qualified -
a using Consultingwerk.Windows.Controls.* would make the
SplitContainer of that package ambiguous with
System.Windows.Forms.SplitContainer

Parameters:
poUiAction Consultingwerk.CommonUi.RefreshTreeViewUiAction
The RefreshTreeViewUiAction with the name of the tree view instance to reload
sender Progress.Lang.Object
The sender of the event
Top

SetCharacterProperty (SetCharacterPropertyUiAction, Object)
Purpose: Sets a character property on the sender object
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.SetCharacterPropertyUiAction
The SetCharacterPropertyUiAction with property name and value
sender Progress.Lang.Object
The sender of the event
Top

SetStatusBarText (SetStatusBarTextUiAction, Object)
Purpose: Sets the StatusBar Text
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.SetStatusBarTextUiAction
The SetStatusBarTextUiAction with property name and value
sender Progress.Lang.Object
The sender of the event
Top

SetTableIoActionDisabled (SetTableIoActionDisabledUiAction, Object)
Purpose: Handles SetTableIoActionDisabledUiActions by permanently disabling
(or enabling again) TableIO tools for a viewer or grid
Notes: SCL-6176. Calls SetTableIOActionDisabled of the TableIO source of
the target and of the toolbar of this handler. A toolbar that does
not know the target, an unknown target and an invalid action name
are ignored with a log entry (UiAction)

Parameters:
poUiAction Consultingwerk.CommonUi.SetTableIoActionDisabledUiAction
The SetTableIoActionDisabledUiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

SetUpdateState (EventHandlerParameter)
Purpose: Sets the UpdateState in the EventHandlerParameter's EventContext
Notes: Determines the UpdateState from the component (SmartUpdatableBrowser,
SmartViewerControl, ISmartToolbarControl, or SmartDatasetAdapter).
For SmartDatasetAdapter, loops through SmartDataTargets to find the
first target in Add, Copy, or Update mode.

Parameters:
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to set EventContext on
Top

ShowInputPrompts (ListInputPrompt)
Purpose: Shows the input prompts
Notes:

Parameters:
poInputPrompts Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The list of input prompts
Top

ShowMessages (ListValidationMessage)
Purpose: Shows the messages
Notes: Applies focus to the first field referenced in a message

Parameters:
poMessages Consultingwerk.OERA.ValidationMessages.ListValidationMessage
The list of messages
Top

ShowNotifications (ListNotification)
Purpose: Shows the notifications via UltraDesktopAlert
Notes: SCL-6080: Delegates to DesktopAlertHelper:ShowNotifications, which
is shared with the display of notifications returned from SaveChanges

Parameters:
poNotifications Consultingwerk.CommonUi.ListNotification
The list of notifications
Top

ShowQuestions (ListQuestion)
Purpose: Shows the questions
Notes:

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of questions
Top

StoreLruEntry (StoreLruEntryUiAction, Object)
Purpose: Handles StoreLruEntryUiActions by storing the current record of
the active DynamicForm in the Ribbon LRU list
Notes: SCL-5305: Triggered from a server-side event handler. Only
supported on a DynamicForm that has a FormLruController (i.e. when
the Form's LruDisplayFieldList repository attribute is set); a
no-op otherwise.

Parameters:
poUiAction Consultingwerk.CommonUi.StoreLruEntryUiAction
The StoreLruEntryUiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

TableIoAction (TableIoUiAction, Object)
Purpose: Handles TableIoUiActions
Notes:

Parameters:
poUiAction Consultingwerk.CommonUi.TableIoUiAction
The TableIoUiAction to handle
sender Progress.Lang.Object
The sender of the event
Top

TableIoActionOnTarget (TableIoUiAction)
Purpose: Handles a TableIoUiAction with a TargetInstanceName by performing
the TableIoAction on that viewer or updatable grid of the Form
Notes: SCL-6097. The tab pages that host the target are activated first.
A target that cannot be found, that is neither a viewer nor an
updatable grid, or that cannot perform the action (e.g. Add
without a parent record) is ignored with a log entry (UiAction)

Parameters:
poUiAction Consultingwerk.CommonUi.TableIoUiAction
The TableIoUiAction to handle
Top

UpdateFormTitle (UpdateFormTitleUiAction, Object)
Purpose: Handles UpdateFormTitleUiActions by setting the title of the
Form that raised the event
Notes: SCL-6094. A BaseForm keeps the title of the Form definition and
restores it for an empty or unknown FormTitle; other Forms
ignore an empty or unknown FormTitle

Parameters:
poUiAction Consultingwerk.CommonUi.UpdateFormTitleUiAction
The UpdateFormTitleUiAction with the new title
sender Progress.Lang.Object
The sender of the event
Top

UpdateLookupDefinition (UpdateLookupDefinitionUiAction, Object)
Purpose: Handles UpdateLookupDefinitionUiActions by applying the lookup
definition to the lookup field of the viewer
Notes: SCL-6066

Parameters:
poUiAction Consultingwerk.CommonUi.UpdateLookupDefinitionUiAction
The UpdateLookupDefinitionUiAction to handle
sender Progress.Lang.Object
The sender of the event


Constructor Detail
Top

SmartUiControlHandlerBase (Component)
Purpose: Constructor for the SmartUiControlHandlerBase class
Notes:

Parameters:
poComponent System.ComponentModel.Component
The component to handle UI control actions for


Property Detail
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl SmartToolbarControl

Returns Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:07:00