Top Method Summary
Options Name Purpose
Consultingwerk.SmartFramework.Repository.Object.CreateDesktopMenuItemParameter BuildDesktopMenuItemParameter (character, character, character) Builds and pre-populates the value object for the Create Desktop Menu Item prompt from the selected object's name and title
Consultingwerk.SmartFramework.Repository.Object.CreateWebMenuItemParameter BuildWebMenuItemParameter (character, character, character) Builds and pre-populates the value object for the Create Web Menu Item prompt from the selected object's name and title
Consultingwerk.CommonUi.UiControl CreateDesktopMenuItemToolClick (dataset, IToolClickEventHandlerParameter) Server-side event handler for the "Create Desktop Menu Item" tool button - prompts for the menu item details and creates a SmartFunction record launching the selected Form on the desktop
CHARACTER CreateSmartFunction (character, character, character, character, character, character, longchar) Creates a SmartFunction (menu item) record using the DatasetModel
Consultingwerk.CommonUi.UiControl CreateWebMenuItemToolClick (dataset, IToolClickEventHandlerParameter) Server-side event handler for the "Create Web Menu Item" tool button - prompts for the menu item details and creates a SmartFunction record launching the selected Form as a web view
GetDataset (dataset-handle) Returns the dataset handled by this server-side event handler class
CHARACTER LastSelectedModuleGuid () Returns the GUID of the module the current user last selected on this screen, read from the user profile
Consultingwerk.Framework.MessageInteraction.InputPromptComboBoxPropertyOptions ModuleComboBoxOptions () Builds the combo box options listing all SmartModule records of the ModuleBusinessEntity
CHARACTER ObjectTitle (character) Looks up the TITLE attribute value of an object master
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowMenuItemPrompt (UiControl, character, character, JsonSerializable, InputPromptProperty[]) Adds (or re-evaluates) the menu item InputPrompt to the UiControl
StoreLastSelectedModuleGuid (character) Stores the GUID of the module the current user selected on this screen in the user profile

Top Property Summary
Options Name Purpose
CHARACTER DesktopMenuItemMessageId
CHARACTER UserProfileKey
CHARACTER UserProfileName
CHARACTER UserProfileType
CHARACTER WebMenuItemMessageId


Method Detail
Top

Consultingwerk.SmartFramework.Repository.Object.CreateDesktopMenuItemParameter BuildDesktopMenuItemParameter (character, character, character)

Purpose: Builds and pre-populates the value object for the Create Desktop
Menu Item prompt from the selected object's name and title
Notes: Pure mapping logic with no service or database dependency

Parameters:
pcObjectName CHARACTER
The name of the selected Form / object master
pcTitle CHARACTER
The TITLE attribute value of the selected object master
pcModuleGuid CHARACTER
The GUID of the module to default the selection to (may be empty)
Returns Consultingwerk.SmartFramework.Repository.Object.CreateDesktopMenuItemParameter
The pre-populated CreateDesktopMenuItemParameter instance
Top

Consultingwerk.SmartFramework.Repository.Object.CreateWebMenuItemParameter BuildWebMenuItemParameter (character, character, character)

Purpose: Builds and pre-populates the value object for the Create Web
Menu Item prompt from the selected object's name and title
Notes: Pure mapping logic with no service or database dependency. The
FunctionCode is derived from the object name (e.g. "CustomerForm"
becomes "customer-form"); the ViewUri points at the SmartForm
route of the object

Parameters:
pcObjectName CHARACTER
The name of the selected Form / object master
pcTitle CHARACTER
The TITLE attribute value of the selected object master
pcModuleGuid CHARACTER
The GUID of the module to default the selection to (may be empty)
Returns Consultingwerk.SmartFramework.Repository.Object.CreateWebMenuItemParameter
The pre-populated CreateWebMenuItemParameter instance
Top

Consultingwerk.CommonUi.UiControl CreateDesktopMenuItemToolClick (dataset, IToolClickEventHandlerParameter)

Purpose: Server-side event handler for the "Create Desktop Menu Item" tool
button - prompts for the menu item details and creates a
SmartFunction record launching the selected Form on the desktop
Notes: SCL-5288

Parameters:
dsObjectMaster DATASET dsObjectMaster
The dataset holding the currently selected eSmartObjectMaster record
poEventArgs Consultingwerk.CommonUi.IToolClickEventHandlerParameter
The tool click event handler parameter
Returns Consultingwerk.CommonUi.UiControl
The UiControl carrying the InputPrompt and notifications back to the frontend
Top

CHARACTER CreateSmartFunction (character, character, character, character, character, character, longchar)

Purpose: Creates a SmartFunction (menu item) record using the DatasetModel
Notes: Validation errors raised by SaveChanges are deliberately not
caught and propagate to the client

Parameters:
pcFunctionName CHARACTER
The function name
pcFunctionCode CHARACTER
The function code (empty for desktop menu items)
pcFunctionModuleGuid CHARACTER
The GUID of the SmartModule the function belongs to
pcFunctionDescription CHARACTER
The function description
pcFunctionSmallImage CHARACTER
The small image of the function
pcFunctionLargeImage CHARACTER
The large image of the function
plcCallParameter LONGCHAR
The serialized function call parameter
Returns CHARACTER
The GUID of the created SmartFunction record
Top

Consultingwerk.CommonUi.UiControl CreateWebMenuItemToolClick (dataset, IToolClickEventHandlerParameter)

Purpose: Server-side event handler for the "Create Web Menu Item" tool
button - prompts for the menu item details and creates a
SmartFunction record launching the selected Form as a web view
Notes: SCL-5288

Parameters:
dsObjectMaster DATASET dsObjectMaster
The dataset holding the currently selected eSmartObjectMaster record
poEventArgs Consultingwerk.CommonUi.IToolClickEventHandlerParameter
The tool click event handler parameter
Returns Consultingwerk.CommonUi.UiControl
The UiControl carrying the InputPrompt and notifications back to the frontend
Top

GetDataset (dataset-handle)

Purpose: Returns the dataset handled by this server-side event handler class
Notes: Required by the SmartComponent Library server-side event handler
infrastructure to obtain the dataset structure for the SSEH invocation

Parameters:
phDataset DATASET-HANDLE
OUTPUT The handle of the dsObjectMaster dataset
Top

CHARACTER LastSelectedModuleGuid ()

Purpose: Returns the GUID of the module the current user last selected on
this screen, read from the user profile
Notes: Returns the empty string when no module has been stored yet

Returns CHARACTER
The last selected module GUID or the empty string
Top

Consultingwerk.Framework.MessageInteraction.InputPromptComboBoxPropertyOptions ModuleComboBoxOptions ()

Purpose: Builds the combo box options listing all SmartModule records of
the ModuleBusinessEntity
Notes: The combo stores the ModuleGuid as the value (FunctionModuleGuid)
and displays the module code (ProductCode). No explicit QueryString
is set: the records are returned (and ordered) by the
ModuleBusinessEntity default sort (BY ModuleName). A custom sort on
the joined ProductCode field cannot be translated by the DataAccess
and would raise a query preparation error (7328). LimitToList is
turned off - the mandatory module value is validated on the backend.

Returns Consultingwerk.Framework.MessageInteraction.InputPromptComboBoxPropertyOptions
The InputPromptComboBoxPropertyOptions for the module combo
Top

CHARACTER ObjectTitle (character)

Purpose: Looks up the TITLE attribute value of an object master
Notes: Returns an empty string when the attribute is not set

Parameters:
pcObjectMasterGuid CHARACTER
The GUID of the object master to look up
Returns CHARACTER
The TITLE attribute value or the empty string
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowMenuItemPrompt (UiControl, character, character, JsonSerializable, InputPromptProperty[])

Purpose: Adds (or re-evaluates) the menu item InputPrompt to the UiControl
Notes: Uses an explicit, stable message id so the prompt is matched
across the initial and subsequent invocations of the SSEH method

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl carrying the list of InputPrompts
pcMessageId CHARACTER
The stable message id identifying the InputPrompt
pcTitle CHARACTER
The title shown above the InputPrompt
poValueObject Consultingwerk.JsonSerializable
The value object backing the InputPrompt
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The properties to render in the InputPrompt
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The MessageReplyEnum (Unanswered, ReplyOk or ReplyCancel)
Top

StoreLastSelectedModuleGuid (character)

Purpose: Stores the GUID of the module the current user selected on this
screen in the user profile
Notes:

Parameters:
pcModuleGuid CHARACTER
The selected module GUID to remember


Property Detail
Top

CHARACTER DesktopMenuItemMessageId


Returns CHARACTER
Top

CHARACTER UserProfileKey


Returns CHARACTER
Top

CHARACTER UserProfileName


Returns CHARACTER
Top

CHARACTER UserProfileType


Returns CHARACTER
Top

CHARACTER WebMenuItemMessageId


Returns CHARACTER


ProDataset Detail

ProDataset dsObjectMaster

Member tables: eSmartObjectMaster, eSmartLink, eSmartObjectInstance, eSmartPage


Temp-Table Detail

Temp-Table eSmartLink

Defined in:

Temp-Table eSmartObjectInstance

Defined in:

Temp-Table eSmartObjectMaster

Defined in:

Temp-Table eSmartPage

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       20.06.2026 07:26:19