Namespace: Consultingwerk.Windows.Framework.Repository.Object
Class 
GenerateServerSideEventHandlerPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.Repository.Object.BaseObjectDesignerObjectTypePlugin
Consultingwerk.Windows.Framework.Repository.Object.GenerateServerSideEventHandlerPlugin

Inherits: Consultingwerk.Windows.Framework.Repository.Object.BaseObjectDesignerObjectTypePlugin
Implements: Consultingwerk.IAction, Consultingwerk.Windows.Framework.Repository.Object.ISmartObjectMasterFormPlugin

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

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



Top Method Summary
Options Name Purpose
AddToolbarButton (ListNameValuePair, JsonObject, character, character) Adds a toolbar button to the temp-table and to the prompt list
Consultingwerk.ListNameValuePair CollectToolbarButtons () Returns the toolbar buttons that dispatch their ToolClick event server-side
LOGICAL ConfirmFrontendSupport (RepositoryEventDescriptor) Confirms the generation when the event is dispatched server-side by only one frontend
CreateAttributeEventHandlerMethod () Creates a server-side event handler method for the selected event attribute
CreateServerSideEventHandlerMethod () Creates a server-side event handler method
CreateToolbarButtonEventHandlerMethod () Creates the server-side event handler method of a toolbar / ribbon button
GenerateServerSideEventHandler () Generates the server-side event handler Business Task
CHARACTER GetDataSourceBusinessEntity (IRepositoryCodeGenerationService) Returns the Business Entity of the container's design time data source
CHARACTER GetServerSideAction (JsonObject, character) Returns the server-side buttonAction of a button definition
CHARACTER GetToolbarButtonNames () Returns the names of the buttons of the selected toolbar instance
LOGICAL IsServerSideEventSelected () Returns if the currently selected attribute is an unhandled server-side event
LOGICAL IsToolbarInstanceSelected () Returns if the selected object instance is a toolbar
Startup (SmartObjectMasterForm, SmartToolbarController, handle) Method called when then SmartObjectMasterForm is started
ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick Event of the ToolbarsController
ValidateButtonEnabled () Validates the Enabled State of the Ribbon Buttons
WriteEventAttribute (character) Writes the event handler value into the selected event attribute

Top Constructor Summary
Options Name Purpose
GenerateServerSideEventHandlerPlugin () Constructor for the GenerateServerSideEventHandlerPlugin class


Method Detail
Top

AddToolbarButton (ListNameValuePair, JsonObject, character, character)
Purpose: Adds a toolbar button to the temp-table and to the prompt list
Notes: SCL-5669 - the frontend is appended to the button name only when
the two frontends dispatch the button to different handlers

Parameters:
poList Consultingwerk.ListNameValuePair
The ListNameValuePair the prompt offers the buttons with
poDefinitions Progress.Json.ObjectModel.JsonObject
The button definitions of the frontend
pcButtonName CHARACTER
The name of the toolbar button
pcFrontend CHARACTER
The name of the frontend, empty when both frontends agree
Top

Consultingwerk.ListNameValuePair CollectToolbarButtons ()
Purpose: Returns the toolbar buttons that dispatch their ToolClick event server-side
Notes: SCL-5669 - fills ttToolbarButton and returns the list the prompt
offers the buttons with. Desktop and Web may dispatch the same
button name to different handler methods - those are offered as
two entries, distinguished by the frontend

Returns Consultingwerk.ListNameValuePair
The ListNameValuePair with the display text of the buttons
Top

LOGICAL ConfirmFrontendSupport (RepositoryEventDescriptor)
Purpose: Confirms the generation when the event is dispatched server-side by only one frontend
Notes: SCL-4372 section 10

Parameters:
poEvent Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
The RepositoryEventDescriptor of the selected event
Returns LOGICAL
Logical value indicating if the generation should continue
Top

CreateAttributeEventHandlerMethod ()
Purpose: Creates a server-side event handler method for the selected event attribute
Notes: SCL-4372 section 10 - the event attribute is set to
server:<class>:<method> <class>:<method>

Top

CreateServerSideEventHandlerMethod ()
Purpose: Creates a server-side event handler method
Notes: SCL-4372 section 10 and SCL-5669 - the two modes of the button,
tested in the same order as in ValidateButtonEnabled

Top

CreateToolbarButtonEventHandlerMethod ()
Purpose: Creates the server-side event handler method of a toolbar / ribbon button
Notes: SCL-5669 - the handler class and the handler method are read from
the buttonAction of the button definition, so nothing is written
back to the repository or to the button definition file

Top

GenerateServerSideEventHandler ()
Purpose: Generates the server-side event handler Business Task
Notes: SCL-4372 section 9

Top

CHARACTER GetDataSourceBusinessEntity (IRepositoryCodeGenerationService)
Purpose: Returns the Business Entity of the container's design time data source
Notes: SCL-4372 section 9 - the design time data source is a field of the
object master record (eSmartObjectMaster.DesignTimeDataSourceGuid)
and names another object master, so it is neither an attribute of
the container nor one of its object instances. The Business Entity
is the EntityName attribute of that data source object master

Parameters:
poGenerator Consultingwerk.BusinessEntityDesigner.Generator.IRepositoryCodeGenerationService
The reference to the IRepositoryCodeGenerationService
Returns CHARACTER
The fully qualified name of the Business Entity, or the empty string
Top

CHARACTER GetServerSideAction (JsonObject, character)
Purpose: Returns the server-side buttonAction of a button definition
Notes: SCL-5669 - answers the empty string when the frontend does not
define the button, when the button has no buttonAction, or when
the buttonAction is not a well formed server:<class>:<method>

Parameters:
poDefinitions Progress.Json.ObjectModel.JsonObject
The button definitions of a frontend
pcButtonName CHARACTER
The name of the toolbar button
Returns CHARACTER
The buttonAction of the button, or the empty string
Top

CHARACTER GetToolbarButtonNames ()
Purpose: Returns the names of the buttons of the selected toolbar instance
Notes: SCL-5669 - the ToolbarButtonsBase and ToolbarButtons attributes
are merged the same way the toolbar renderers of the two
frontends merge them

Returns CHARACTER
The comma delimited list of the toolbar button names
Top

LOGICAL IsServerSideEventSelected ()
Purpose: Returns if the currently selected attribute is an unhandled server-side event
Notes: SCL-4372 section 10 - the event has to be dispatched server-side by
at least one of the two frontends

Returns LOGICAL
Logical value indicating if a server-side handler method can be generated
Top

LOGICAL IsToolbarInstanceSelected ()
Purpose: Returns if the selected object instance is a toolbar
Notes: SCL-5669 - the handler of a toolbar / ribbon button is the
buttonAction of the button definition rather than an attribute of
the toolbar instance, so this mode of the button depends on
neither the ServerSideEventHandler attribute of the container nor
the attribute selected in one of the two attribute grids.
The object type of the container is not tested either - a
MetaToolbar instance lives on a MetaForm as well as on a
MetaControlGroup, and selecting one is proof enough that the
container hosts toolbars

Returns LOGICAL
Logical value indicating if the toolbar button prompt applies
Top

Startup (SmartObjectMasterForm, SmartToolbarController, handle)
Purpose: Method called when then SmartObjectMasterForm is started
Notes:

Parameters:
poForm Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm
The reference to the SmartObjectMasterForm instance
poToolbar Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController instance
phDataset HANDLE
The handle of the dsObjectMaster dataset
Top

ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick Event of the ToolbarsController
Notes:

Parameters:
sender System.Object
The reference to the object that raise the event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event
Top

ValidateButtonEnabled ()
Purpose: Validates the Enabled State of the Ribbon Buttons
Notes: SCL-4372 sections 9 and 10

Top

WriteEventAttribute (character)
Purpose: Writes the event handler value into the selected event attribute
Notes: SCL-4372

Parameters:
pcValue CHARACTER
The value to store in the event attribute


Constructor Detail
Top

GenerateServerSideEventHandlerPlugin ()
Purpose: Constructor for the GenerateServerSideEventHandlerPlugin class
Notes: The ServerSideEventHandler attribute is registered on MetaContainer
and on MetaGrid, MetaLookup, MetaToolbar and MetaFileUpload



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:22:16