Top Method Summary
Options Name Purpose
ActivateTabFolderPage (ActivateTabFolderPageUiAction, Object) Activates a tab folder page
CallMethod (MethodCallParameter) Executes the method referenced by the MethodCallParameter instance
EnableDisableTabPage (EnableDisableTabPageUiAction, Object) Enables or disables a tab page
EnableToolbarButton (EnableToolbarButtonUiAction, Object) Handles EnableToolbarButtonUiActions
A System.Windows.Forms.Form FindForm () Finds the form associated with the control
A Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource () Gets the data source
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
OpenQuery (OpenQueryUiAction, Object) Opens a query
OpenWebPage (OpenWebPageUiAction, Object) Opens a web page
SetCharacterProperty (SetCharacterPropertyUiAction, Object) Sets a character property on the sender object
SetStatusBarText (SetStatusBarTextUiAction, Object) Sets the StatusBar Text
SetUpdateState (EventHandlerParameter) Sets the UpdateState in the EventHandlerParameter's EventContext
ShowInputPrompts (ListInputPrompt) Shows the input prompts
ShowMessages (ListValidationMessage) Shows the messages
ShowQuestions (ListQuestion) Shows the questions
A TableIoAction (TableIoUiAction, Object) Handles TableIoUiActions

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

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

CallMethod (MethodCallParameter)

Purpose: Executes the method referenced by the MethodCallParameter instance
Notes:

Parameters:
poMethodCallParameter Consultingwerk.CommonUi.MethodCallParameter
The reference to the MethodCallParameter instance
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:

Parameters:
poUiAction Consultingwerk.CommonUi.EnableToolbarButtonUiAction
The EnableToolbarButtonUiAction to handle
sender Progress.Lang.Object
The sender of the event
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

HANDLE GetScreenValuesDataset ()

Purpose: Gets the screen values dataset
Notes:

Returns HANDLE
The screen values dataset
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

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

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

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

ShowQuestions (ListQuestion)

Purpose: Shows the questions
Notes:

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of questions
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


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


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       03.05.2026 21:39:19