Top Method Summary
Options Name Purpose
AddFieldValueLists (Control, EventHandlerParameter) Adds the current value lists of the combo box and multiselect fields of a viewer to the EventHandlerParameter
AddFormContext (Form, EventHandlerParameter) Copies the FormContext from the launched Form (if present) to the EventHandlerParameter so the server-side event handler can inspect (and update) the current Form-level state. Notes : SCL-5261 - only Forms inheriting from Consultingwerk.Forms.BaseForm carry a FormContext property. For other Form types this method is a no-op. The backend can return an updated context via UiControl:FormContext; the SmartUiControlHandlerBase applies it back to the BaseForm. @param poForm The Form whose FormContext should be copied @param poEventHandlerParameter The EventHandlerParameter to populate */
AddFormParameter (Form, EventHandlerParameter) Copies the FormParameter from the launched Form (if present) to the EventHandlerParameter so the server-side event handler can inspect the context the Form was launched with. Notes : SCL-5257 - only Forms inheriting from Consultingwerk.Forms.BaseForm carry a FormParameter property. For other Form types this method is a no-op. @param poForm The Form whose FormParameter should be copied @param poEventHandlerParameter The EventHandlerParameter to populate */
AddFormTitle (Form, EventHandlerParameter) Copies the current title and the title of the Form definition to the EventHandlerParameter
AddTabFolderStatus (Form, EventHandlerParameter) Adds status information for all tab folders in the given form Notes : Adds an item for every UltraTabControl in the form, containing the instance name, active page number and active page key @param poForm The form to scan @param poEventHandlerParameter The EventHandlerParameter to populate */
AddUnboundValues (Form, EventHandlerParameter) Copies the current values of the unbound editors of the Form to the EventHandlerParameter so the server-side event handler can read them. Notes : SCL-5618 - unbound editors have no representation in the ProDataset passed to the handler. The backend returns updated values via UiControl:UnboundValues; the SmartUiControlHandlerBase applies them back to the editors. @param poForm The Form whose unbound values should be collected @param poEventHandlerParameter The EventHandlerParameter to populate */
Consultingwerk.CommonUi.EventHandlerParameter CreateEventHandlerParameter (Form, Control, character, character, character) Creates a new EventHandlerParameter instance
Consultingwerk.Forms.BaseForm FindHostBaseForm (Object) Locates the host BaseForm for the given non-visual data adapter (e.g. a Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter) by walking the SmartDataTargets list looking for the first bound Control whose containing Form is a BaseForm. Notes : SCL-5257 - used to forward the BaseForm:FormParameter to SSEH invocations originating from non-visual data adapters that do not have a direct Form reference. Returns the unknown value when no BaseForm can be located. @param poSource The SmartDataAdapter (or any object exposing SmartDataTargets) to inspect @return The host BaseForm or unknown if none can be located */
Consultingwerk.CommonUi.RecordModeEnum GetRecordMode (Object) Returns the record mode of a TableIO target (viewer, updatable grid) for the RecordMode of the EventHandlerParameter

Top Constructor Summary
Options Name Purpose
EventHandlerParameterFactory () Default constructor for EventHandlerParameterFactory


Method Detail
Top

AddFieldValueLists (Control, EventHandlerParameter)

Purpose: Adds the current value lists of the combo box and multiselect
fields of a viewer to the EventHandlerParameter
Notes: SCL-6251 - only for events of a SmartViewerControl. One entry per
UltraComboEditor or MultiSelectControl with a non-empty value
list, named after the control. The GUI for .NET client does not
keep the source of a value list (items, pairs, SmartValueList
key), so the value list is always passed as ValueListItemPairs.
Combo boxes that read their entries from a Business Entity
(EntityName) are skipped

Parameters:
poContainer System.Windows.Forms.Control
The container of the sender of the event, may be invalid
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

AddFormContext (Form, EventHandlerParameter)

Purpose: Copies the FormContext from the launched Form (if present) to
the EventHandlerParameter so the server-side event handler can
inspect (and update) the current Form-level state.
Notes : SCL-5261 - only Forms inheriting from Consultingwerk.Forms.BaseForm
carry a FormContext property. For other Form types this method
is a no-op. The backend can return an updated context via
UiControl:FormContext; FormContext; the SmartUiControlHandlerBase applies it
back to the BaseForm.

Parameters:
poForm System.Windows.Forms.Form
The Form whose FormContext should be copied
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

AddFormParameter (Form, EventHandlerParameter)

Purpose: Copies the FormParameter from the launched Form (if present) to
the EventHandlerParameter so the server-side event handler can
inspect the context the Form was launched with.
Notes : SCL-5257 - only Forms inheriting from Consultingwerk.Forms.BaseForm
carry a FormParameter property. For other Form types this method
is a no-op.

Parameters:
poForm System.Windows.Forms.Form
The Form whose FormParameter should be copied
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

AddFormTitle (Form, EventHandlerParameter)

Purpose: Copies the current title and the title of the Form definition
to the EventHandlerParameter
Notes: SCL-6095 - a BaseForm reports the title it was designed or
rendered with as the DesignFormTitle, also after an
UpdateFormTitleUiAction (SCL-6094) changed the title. For other
Forms both values are the current title.

Parameters:
poForm System.Windows.Forms.Form
The Form whose title should be passed
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

AddTabFolderStatus (Form, EventHandlerParameter)

Purpose: Adds status information for all tab folders in the given form
Notes : Adds an item for every UltraTabControl in the form, containing
the instance name, active page number and active page key

Parameters:
poForm System.Windows.Forms.Form
The form to scan
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

AddUnboundValues (Form, EventHandlerParameter)

Purpose: Copies the current values of the unbound editors of the Form to
the EventHandlerParameter so the server-side event handler can
read them.
Notes : SCL-5618 - unbound editors have no representation in the
ProDataset passed to the handler. The backend returns updated
values via UiControl:UnboundValues; the SmartUiControlHandlerBase
applies them back to the editors.

Parameters:
poForm System.Windows.Forms.Form
The Form whose unbound values should be collected
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter to populate
Top

Consultingwerk.CommonUi.EventHandlerParameter CreateEventHandlerParameter (Form, Control, character, character, character)

Purpose: Creates a new EventHandlerParameter instance
Notes:

Parameters:
poForm System.Windows.Forms.Form
The form to scan
poContainer System.Windows.Forms.Control
The container to scan
pcSenderName CHARACTER
The name of the sender
pcItemKey CHARACTER
The key of the item
pcEventName CHARACTER
The name of the event
Returns Consultingwerk.CommonUi.EventHandlerParameter
The new EventHandlerParameter instance
Top

Consultingwerk.Forms.BaseForm FindHostBaseForm (Object)

Purpose: Locates the host BaseForm for the given non-visual data adapter
(e.g. a Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter)
by walking the SmartDataTargets list looking for the first bound
Control whose containing Form is a BaseForm.
Notes : SCL-5257 - used to forward the BaseForm:FormParameter to SSEH
invocations originating from non-visual data adapters that do
not have a direct Form reference. Returns the unknown value
when no BaseForm can be located.

Parameters:
poSource Progress.Lang.Object
The SmartDataAdapter (or any object exposing SmartDataTargets) to inspect
Returns Consultingwerk.Forms.BaseForm
The host BaseForm or unknown if none can be located
Top

Consultingwerk.CommonUi.RecordModeEnum GetRecordMode (Object)

Purpose: Returns the record mode of a TableIO target (viewer, updatable
grid) for the RecordMode of the EventHandlerParameter
Notes: SCL-6085 - View when the object does not report a record mode
(no viewer context, e.g. a Form or a data source)

Parameters:
poTableIoTarget Progress.Lang.Object
The TableIO target (viewer) the event belongs to, may be invalid
Returns Consultingwerk.CommonUi.RecordModeEnum
The RecordModeEnum value


Constructor Detail
Top

EventHandlerParameterFactory ()

Purpose: Default constructor for EventHandlerParameterFactory
Notes:



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