Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartFormServerSideEventHandler Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartComponents.Implementation.SmartFormServerSideEventHandler

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
Consultingwerk.CommonUi.UiControl DispatchEvent (character, character, character, Object) Builds the EventHandlerParameter and invokes the configured server-side event handler method.
Consultingwerk.CommonUi.UiControl DispatchEvent2 (character, character, character, Object, character, Object) Builds the EventHandlerParameter and invokes the configured server-side event handler method, allowing the caller to provide an explicit FormResponse value plus the name and FormParameter of the launched modal Form.
CHARACTER GetDialogResultName () Returns the DialogResultEnum member name derived from the Form's .NET DialogResult property. Returns an empty string when the Form is not a modal Form (DialogResult is None).
HandleFormClosed (FormClosedEventArgs) Dispatches the FormClosed event to the registered SSEH handler.
HandleFormClosing (FormClosingEventArgs) Dispatches the FormClosing event to the registered SSEH handler.
HandleModalFormClosed (FormResult) Dispatches the ModalFormClosed event to the registered SSEH handler on the parent Form.
LOGICAL HasSubscriptions () Returns true when at least one of the supported lifecycle events (FormClosing or FormClosed) has an SSEH handler registered.

Top Constructor Summary
Options Name Purpose
SmartFormServerSideEventHandler (BaseForm) Default constructor for SmartFormServerSideEventHandler.

Top Property Summary
Options Name Purpose
Consultingwerk.Forms.BaseForm Form
CHARACTER FormClosedHandlerName
CHARACTER FormClosingHandlerName
CHARACTER ModalFormClosedHandlerName


Method Detail
Top

Consultingwerk.CommonUi.UiControl DispatchEvent (character, character, character, Object)
Purpose: Builds the EventHandlerParameter and invokes the configured
server-side event handler method.
Notes: Returns the UiControl returned from InvokeTask2 so callers can
inspect Cancel etc.

Parameters:
pcHandlerName CHARACTER
The full handler reference in the form ":TaskClass:MethodName"
pcEventName CHARACTER
The Form-level event name (FormClosing or FormClosed)
pcDialogResult CHARACTER
The DialogResultEnum member name to forward to the backend (may be unknown)
e Progress.Lang.Object
The .NET event arguments
Returns Consultingwerk.CommonUi.UiControl
The UiControl returned by the SSEH method
Top

Consultingwerk.CommonUi.UiControl DispatchEvent2 (character, character, character, Object, character, Object)
Purpose: Builds the EventHandlerParameter and invokes the configured
server-side event handler method, allowing the caller to
provide an explicit FormResponse value plus the name and
FormParameter of the launched modal Form.
Notes: SCL-5262 - used by HandleModalFormClosed to forward the
FormResponse, FormName and FormParameter from the closed
modal Form (carried in the FormResult) rather than the
parent Form's own FormResponse. For FormClosing / FormClosed
(where the SSEH fires on the modal Form itself) the
LaunchedFormName / LaunchedFormParameter slots are left
empty and the launched-form context is already available
via the regular FormName / FormParameter slots populated
by the EventHandlerParameterFactory.

Parameters:
pcHandlerName CHARACTER
The full handler reference in the form ":TaskClass:MethodName"
pcEventName CHARACTER
The Form-level event name (FormClosing / FormClosed / ModalFormClosed)
pcDialogResult CHARACTER
The DialogResultEnum member name to forward to the backend (may be unknown)
poFormResponse Progress.Lang.Object
The FormResponse to forward to the backend (may be unknown)
pcLaunchedFormName CHARACTER
The name of the closed modal Form (empty when not applicable)
poLaunchedFormParameter Progress.Lang.Object
The FormParameter of the closed modal Form (unknown when not applicable)
Returns Consultingwerk.CommonUi.UiControl
The UiControl returned by the SSEH method
Top

CHARACTER GetDialogResultName ()
Purpose: Returns the DialogResultEnum member name derived from the Form's
.NET DialogResult property. Returns an empty string when the Form
is not a modal Form (DialogResult is None).
Notes: The character form is used so the value can be carried in the
serializable EventHandlerParameter (Consultingwerk.Enum is not
serializable across an AppServer call).

Returns CHARACTER
The DialogResultEnum member name or "" when not applicable
Top

HandleFormClosed (FormClosedEventArgs)
Purpose: Dispatches the FormClosed event to the registered SSEH handler.
Notes: For Forms launched modally the DialogResultEnum is derived from
the .NET FormClosedEventArgs:CloseReason and the Form's own
DialogResult and forwarded to the backend via the
EventHandlerParameter.

Parameters:
e System.Windows.Forms.FormClosedEventArgs
The FormClosedEventArgs with the data for this event
Top

HandleFormClosing (FormClosingEventArgs)
Purpose: Dispatches the FormClosing event to the registered SSEH handler.
Notes: The .NET FormClosingEventArgs:Cancel flag is mirrored back from
UiControl:Cancel Cancel so the backend can veto the closing of the Form.

Parameters:
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
Top

HandleModalFormClosed (FormResult)
Purpose: Dispatches the ModalFormClosed event to the registered SSEH
handler on the parent Form.
Notes: SCL-5262 - invoked on the parent Form when a modal Form
launched via SmartFormFactory:LaunchModalForm closes. The
EventHandlerParameter carries the FormResponse and
DialogResult from the FormResult so the parent's backend
can react to the modal interaction.

Parameters:
poFormResult Consultingwerk.Forms.FormResult
The FormResult returned by SmartFormFactory:LaunchModalForm
Top

LOGICAL HasSubscriptions ()
Purpose: Returns true when at least one of the supported lifecycle events
(FormClosing or FormClosed) has an SSEH handler registered.
Notes:

Returns LOGICAL
Logical value indicating if any subscription exists


Constructor Detail
Top

SmartFormServerSideEventHandler (BaseForm)
Purpose: Default constructor for SmartFormServerSideEventHandler.
Notes:

Parameters:
poForm Consultingwerk.Forms.BaseForm
The reference to the BaseForm instance whose lifecycle events should be dispatched as SSEH


Property Detail
Top

Consultingwerk.Forms.BaseForm Form

Returns Consultingwerk.Forms.BaseForm
Top

CHARACTER FormClosedHandlerName

Returns CHARACTER
Top

CHARACTER FormClosingHandlerName

Returns CHARACTER
Top

CHARACTER ModalFormClosedHandlerName

Returns CHARACTER


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