Top Method Summary
Options Name Purpose
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 */
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 */
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 */

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


Method Detail
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

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

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


Constructor Detail
Top

EventHandlerParameterFactory ()

Purpose: Default constructor for EventHandlerParameterFactory
Notes:



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.05.2026 16:20:35