Namespace: Consultingwerk.SmartFramework.Menu
Class 
MenuItemDesignBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.SmartFramework.Menu.MenuItemDesignBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessService, ISupportsRestMethods


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



Top Method Summary
Options Name Purpose
Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateDesktopMenuItem (character, character, character, character, character, character) Creates a menu function that launches a Form on the Desktop (GUI for .NET), optionally together with the matching menu item
Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateMenuFunction (character, character, character, character, character, longchar, character) Creates the SmartFunction record and - when a menu structure path is provided - the SmartMenu record referencing it
CHARACTER CreateSmartFunction (character, character, character, character, character, longchar) Creates the SmartFunction (menu function) record
CHARACTER CreateSmartMenuItem (character, character, character, character, character) Creates the SmartMenu (menu item) record below the given menu structure
Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateWebMenuItem (character, character, character, character, character, character, character) Creates a menu function that launches a Form on the Web (Angular), optionally together with the matching menu item
INTEGER NextMenuSequence (character) Returns the MenuSequence value to use for a new menu item appended at the end of the given menu structure
CHARACTER ResolveMenuStructureGuid (character) Resolves a menu structure path or menu structure GUID into the GUID of the menu structure to create the menu item below
CHARACTER ResolveMenuStructureSegment (character, character, character) Resolves a single segment of a menu structure path into the GUID of the menu structure it describes
CHARACTER ResolveViewUri (character) Returns the ViewUri of a web menu function

Top Property Summary
Options Name Purpose
CHARACTER MenuStructurePathDelimiter
CHARACTER MenuStructureTypeItem
CHARACTER MenuStructureTypeMenu


Method Detail
Top

Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateDesktopMenuItem (character, character, character, character, character, character)
Purpose: Creates a menu function that launches a Form on the Desktop
(GUI for .NET), optionally together with the matching menu item
Notes: The Form is referenced through the ClassName property of a
LaunchFormCallParameter instance, which accepts both the name of a
MetaForm repository object master and the fully qualified name of a
static GUI for .NET class

Parameters:
pcMenuLabel CHARACTER
The menu name / label of the new menu function (mandatory)
pcProductModule CHARACTER
The name or GUID of a repository product module (mandatory)
pcSmallImage CHARACTER
The relative file name of a PNG image, small image (optional)
pcLargeImage CHARACTER
The relative file name of a PNG image, large image (optional)
pcFormName CHARACTER
The MetaForm object name or static GUI for .NET class name to launch (mandatory)
pcMenuStructurePath CHARACTER
The menu structure path or menu structure GUID (optional)
Returns Consultingwerk.SmartFramework.Menu.CreateMenuItemResult
The CreateMenuItemResult with the GUID's of the created records
Top

Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateMenuFunction (character, character, character, character, character, longchar, character)
Purpose: Creates the SmartFunction record and - when a menu structure path is
provided - the SmartMenu record referencing it
Notes: The menu structure is resolved before the transaction is started, so
an unresolvable path does not leave a menu function behind. Both saves
run in a single transaction, making the pair all-or-nothing

Parameters:
pcMenuLabel CHARACTER
The menu name / label of the new menu function
pcFunctionCode CHARACTER
The function code (the Angular router path, empty for Desktop menu items)
pcProductModule CHARACTER
The name or GUID of a repository product module
pcSmallImage CHARACTER
The small image of the new menu function
pcLargeImage CHARACTER
The large image of the new menu function
plcCallParameter LONGCHAR
The serialized function call parameter
pcMenuStructurePath CHARACTER
The menu structure path or menu structure GUID (optional)
Returns Consultingwerk.SmartFramework.Menu.CreateMenuItemResult
The CreateMenuItemResult with the GUID's of the created records
Top

CHARACTER CreateSmartFunction (character, character, character, character, character, longchar)
Purpose: Creates the SmartFunction (menu function) record
Notes: The FunctionGuid is assigned by the SmartDB CREATE trigger and is
available in the DatasetModel once SaveChanges has completed

Parameters:
pcFunctionName CHARACTER
The function name
pcFunctionCode CHARACTER
The function code (empty for Desktop menu items)
pcProductModule CHARACTER
The name or GUID of a repository product module
pcSmallImage CHARACTER
The small image of the new menu function
pcLargeImage CHARACTER
The large image of the new menu function
plcCallParameter LONGCHAR
The serialized function call parameter
Returns CHARACTER
The GUID of the created SmartFunction record
Top

CHARACTER CreateSmartMenuItem (character, character, character, character, character)
Purpose: Creates the SmartMenu (menu item) record below the given menu structure
Notes: The MenuGuid is assigned by the SmartDB CREATE trigger. The item is
appended at the end of its level

Parameters:
pcParentMenuGuid CHARACTER
The GUID of the menu structure to create the menu item below
pcMenuLabel CHARACTER
The menu name / label of the new menu item
pcFunctionGuid CHARACTER
The GUID of the SmartFunction the menu item launches
pcSmallImage CHARACTER
The small image of the new menu item
pcLargeImage CHARACTER
The large image of the new menu item
Returns CHARACTER
The GUID of the created SmartMenu record
Top

Consultingwerk.SmartFramework.Menu.CreateMenuItemResult CreateWebMenuItem (character, character, character, character, character, character, character)
Purpose: Creates a menu function that launches a Form on the Web (Angular),
optionally together with the matching menu item
Notes: The Angular route is only generated by the SmartRoutesService when
both the FunctionCode (router path) and the ViewUri of the
LaunchWebViewCallParameter carry a value, so both are mandatory

Parameters:
pcMenuLabel CHARACTER
The menu name / label of the new menu function (mandatory)
pcProductModule CHARACTER
The name or GUID of a repository product module (mandatory)
pcSmallImage CHARACTER
A font based icon or the relative file name of a PNG image, small image (optional)
pcLargeImage CHARACTER
A font based icon or the relative file name of a PNG image, large image (optional)
pcFunctionCode CHARACTER
The Angular router path of the menu function (mandatory)
pcViewUri CHARACTER
The name of the repository form to launch, or a complete view URI (mandatory)
pcMenuStructurePath CHARACTER
The menu structure path or menu structure GUID (optional)
Returns Consultingwerk.SmartFramework.Menu.CreateMenuItemResult
The CreateMenuItemResult with the GUID's of the created records
Top

INTEGER NextMenuSequence (character)
Purpose: Returns the MenuSequence value to use for a new menu item appended at
the end of the given menu structure
Notes: Returns 1 when the menu structure has no children yet

Parameters:
pcParentMenuGuid CHARACTER
The GUID of the menu structure to inspect
Returns INTEGER
The MenuSequence value for the new menu item
Top

CHARACTER ResolveMenuStructureGuid (character)
Purpose: Resolves a menu structure path or menu structure GUID into the GUID of
the menu structure to create the menu item below
Notes: The value is used as-is when it identifies an existing SmartMenu record.
Otherwise it is treated as the backslash delimited path produced by the
Copy Menu Path function of the Menu Maintenance (SCL-5681) and resolved
level by level, starting at the top level menu structures

Parameters:
pcMenuStructurePath CHARACTER
The menu structure path or menu structure GUID
Returns CHARACTER
The GUID of the resolved menu structure
Top

CHARACTER ResolveMenuStructureSegment (character, character, character)
Purpose: Resolves a single segment of a menu structure path into the GUID of the
menu structure it describes
Notes: The MenuStructureCode takes precedence over the MenuName, mirroring the
precedence the Copy Menu Path function applies when building the path.
Only menu structures are considered - a menu item cannot carry children

Parameters:
pcParentMenuGuid CHARACTER
The GUID of the menu structure of the level above (empty for the top level)
pcSegment CHARACTER
The path segment to resolve
pcMenuStructurePath CHARACTER
The complete menu structure path, for the error message
Returns CHARACTER
The GUID of the resolved menu structure
Top

CHARACTER ResolveViewUri (character)
Purpose: Returns the ViewUri of a web menu function
Notes: A value that already is a URI is returned unchanged; the name of a
repository form is expanded to the SmartForm route of that form

Parameters:
pcViewUri CHARACTER
The name of the repository form or a complete view URI
Returns CHARACTER
The ViewUri to store in the LaunchWebViewCallParameter


Property Detail
Top

CHARACTER MenuStructurePathDelimiter

Returns CHARACTER
Top

CHARACTER MenuStructureTypeItem

Returns CHARACTER
Top

CHARACTER MenuStructureTypeMenu

Returns CHARACTER


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