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

Inherits: Consultingwerk.SmartComponents.Base.SmartUiControlHandlerBase


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



Top Method Summary
Options Name Purpose
ApplyFieldControls (UiControl, Object) Applies the FieldControls of the UiControl to the SmartViewerControls of the Form
System.Windows.Forms.Form FindForm () Finds the form associated with the control
Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetDatasource () Gets the datasource associated with the Form
HANDLE GetScreenValuesDataset () Returns a ProDataset with the current record of the primary data source of the Form
System.Windows.Forms.Control GetViewerField (character) Retrieves the control associated with the field
Consultingwerk.CommonUi.UiControl HandleServerEvent (EventHandlerParameter, character, character, Object, Object) Invokes the server-side event handler, including the round trips for unanswered Questions and InputPrompts
HandleUiControl (UiControl, handle, Object) Handles the UiControl returned by the server-side event handler
CHARACTER ResolveViewerFieldName (SmartViewerControl, character) Returns the name of the field of the given viewer that a FieldControl addresses
TableIoAction (TableIoUiAction, Object) Handles TableIoUiActions

Top Constructor Summary
Options Name Purpose
SmartFormUiControlHandler (SmartWindowForm) Constructor for the SmartFormUiControlHandler class

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


Method Detail
Top

ApplyFieldControls (UiControl, Object)
Purpose: Applies the FieldControls of the UiControl to the
SmartViewerControls of the Form
Notes: Each FieldControl is applied to one viewer only. A field name
qualified with the viewer name addresses that viewer, an
unqualified field name the first viewer that contains a control
of that name. FieldControls that do not resolve to a viewer
field are ignored.

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl returned by the server-side event handler
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 datasource associated with the Form
Notes: The primary data source of the Form, when it is a
SmartDatasetAdapter

Returns Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The datasource associated with the Form
Top

HANDLE GetScreenValuesDataset ()
Purpose: Returns a ProDataset with the current record of the primary
data source of the Form
Notes: Returns the unknown value when IncludeScreenValues is FALSE or
the Form has no primary data source with a ProDataset. The
caller is responsible for deleting the ProDataset.

Returns HANDLE
The handle of the ProDataset or the unknown value
Top

System.Windows.Forms.Control GetViewerField (character)
Purpose: Retrieves the control associated with the field
Notes: Resolves both a qualified (<viewer name>.<field name>) and an
unqualified field name against the viewers of the Form

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

Consultingwerk.CommonUi.UiControl HandleServerEvent (EventHandlerParameter, character, character, Object, Object)
Purpose: Invokes the server-side event handler, including the round trips
for unanswered Questions and InputPrompts
Notes: Unlike the SmartUiControlHandlerBase implementation the ProDataset
with the screen values is deleted afterwards. The Cancel flag of
the returned UiControl is mirrored to the event arguments.

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

HandleUiControl (UiControl, handle, Object)
Purpose: Handles the UiControl returned by the server-side event handler
Notes: Applies the FieldControls to the viewers of the Form and the
FocusFieldName, then the generic handling of the base class

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

CHARACTER ResolveViewerFieldName (SmartViewerControl, character)
Purpose: Returns the name of the field of the given viewer that a
FieldControl addresses
Notes: A qualified field name (<viewer name>.<field name>) resolves
only for the viewer of that name, an unqualified field name for
every viewer that contains a control of that name

Parameters:
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The SmartViewerControl to test
pcFieldName CHARACTER
The field name of the FieldControl
Returns CHARACTER
The unqualified field name or the unknown value when the FieldControl does not address the viewer
Top

TableIoAction (TableIoUiAction, Object)
Purpose: Handles TableIoUiActions
Notes: Forwarded to the SmartToolbarSource of the Form, which applies
the action to its active TableIO target

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


Constructor Detail
Top

SmartFormUiControlHandler (SmartWindowForm)
Purpose: Constructor for the SmartFormUiControlHandler class
Notes:

Parameters:
poForm Consultingwerk.SmartComponents.Base.SmartWindowForm
The reference to the SmartWindowForm instance


Property Detail
Top

LOGICAL IncludeScreenValues

Returns LOGICAL
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       09.11.2026 08:06:55