Namespace: Consultingwerk.Windows.Framework.Controls
Class 
MainMenuRenderer Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.Controls.MainMenuRenderer

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Windows.Framework.Controls.IMainMenuRenderer


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



Top Method Summary
Options Name Purpose
IndexMenuStructureForSearch (IMenuStructureProvider) Indexes the leaf menu functions of the rendered menu structure for the Quick-Launch search (SCL-5687), publishing them via the static MenuStructureLoaded event. Reuses the IMenuStructureProvider cache warmed by PreloadMenuStructures in RenderMenuStructure, so this adds no additional AppServer round-trip
Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl InitializeExplorerBarGroup (character, character, character, character, character, integer, logical, UltraExplorerBar) Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl InitializeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
Consultingwerk.Windows.Framework.Controls.MenuStructureExplorerBarGroupController InitializeNativeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with the native Explorer Bar Items
Consultingwerk.Windows.Framework.Controls.LastRecentlyUsedExplorerBarGroupController InitializeRecentlyUsedMenuItemsGroup (character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with recently used menu items
Consultingwerk.Windows.Framework.Controls.MenuStructureRibbonTabController InitializeRibbonTab (character, UltraToolbarsManager) Initializes a MenuStructureRibbonTabController instance
Consultingwerk.Windows.Framework.Controls.MenuTaskListControl InitializeTaskList (character, character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with the SmartFramework MenuTaskListControl
RemoveGroupsIfNotAuthorized (UltraExplorerBar) Cleanup existing groups if the user is no longer authorized
INTEGER RemoveGroupToReload (character, UltraExplorerBar, integer) Removes an existing UltraExplorerBarGroup to be enable reloading it. The old index or of the group or the current index value to be added is returned, to have the group at the same position again.
RenderMenuStructure (UltraExplorerBar, UltraToolbarsManager, Form) Render or refreshes the SmartFramework Menu displayed in an ultraExplorerBar and ultraToolbarsManager instance

Top Constructor Summary
Options Name Purpose
MainMenuRenderer () Constructor for the MainMenuRenderer class
MainMenuRenderer (BaseForm) Constructor for the MainMenuRenderer class

Top Event Summary
Options Name Purpose
MenuStructureLoaded (Object, MenuStructureLoadedEventArgs) Raised after (re-)rendering a menu structure, with the leaf menu functions found while rendering (SCL-5687 Quick-Launch)

Top Property Summary
Options Name Purpose
CHARACTER ConstantExplorerBarGroups
LOGICAL MenuTreeViewControlSortAlphabetical
LOGICAL RenderRecentGroup


Method Detail
Top

IndexMenuStructureForSearch (IMenuStructureProvider)
Purpose: Indexes the leaf menu functions of the rendered menu structure
for the Quick-Launch search (SCL-5687), publishing them via
the static MenuStructureLoaded event. Reuses the
IMenuStructureProvider cache warmed by PreloadMenuStructures
in RenderMenuStructure, so this adds no additional AppServer
round-trip
Notes: Failures here are non-fatal - Quick-Launch search indexing is
an optimization, not a rendering requirement

Parameters:
poMenuProvider Consultingwerk.Windows.Framework.IMenuStructureProvider
The IMenuStructureProvider instance to read from
Top

Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl InitializeExplorerBarGroup (character, character, character, character, character, integer, logical, UltraExplorerBar)
Purpose: Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
Notes:

Parameters:
pcGroupKey CHARACTER
The key of the Group to initialize
pcGroupTitle CHARACTER
The title of the group to initialize
pcRootNodeKey CHARACTER
The key of the RootNode for the Menu
pcSmallImageKey CHARACTER
The key of the small Group Image
pcLargeImageKey CHARACTER
The key of the large Group Image
piPosition INTEGER
The position of the Explorer Bar Group or ?
plRenderRootNode LOGICAL
Logical value indicating if the RootNode should be rendered
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Returns Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl
The reference to the MenuTreeViewControl instance
Top

Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl InitializeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar)
Purpose: Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
Notes:

Parameters:
pcGroupKey CHARACTER
The key of the Group to initialize
pcGroupTitle CHARACTER
The title of the group to initialize
pcRootNodeKey CHARACTER
The key of the RootNode for the Menu
pcSmallImageKey CHARACTER
The key of the small Group Image
pcLargeImageKey CHARACTER
The key of the large Group Image
piPosition INTEGER
The position of the Explorer Bar Group or ?
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Returns Consultingwerk.Windows.Framework.Controls.MenuTreeViewControl
The reference to the MenuTreeViewControl instance
Top

Consultingwerk.Windows.Framework.Controls.MenuStructureExplorerBarGroupController InitializeNativeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar)
Purpose: Initializes an ExplorerBarGroup with the native Explorer Bar Items
Notes:

Parameters:
pcGroupKey CHARACTER
The key of the Group to initialize
pcGroupTitle CHARACTER
The title of the group to initialize
pcRootNodeKey CHARACTER
The key of the RootNode for the Menu
pcSmallImageKey CHARACTER
The key of the small Group Image
pcLargeImageKey CHARACTER
The key of the large Group Image
piPosition INTEGER
The position of the Explorer Bar Group or ?
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Returns Consultingwerk.Windows.Framework.Controls.MenuStructureExplorerBarGroupController
The reference to the MenuStructureExplorerBarGroupController instance
Top

Consultingwerk.Windows.Framework.Controls.LastRecentlyUsedExplorerBarGroupController InitializeRecentlyUsedMenuItemsGroup (character, character, character, character, integer, UltraExplorerBar)
Purpose: Initializes an ExplorerBarGroup with recently used menu items
Notes:

Parameters:
pcGroupKey CHARACTER
The key of the Group to initialize
pcGroupTitle CHARACTER
The title of the group to initialize
pcSmallImageKey CHARACTER
The key of the small Group Image
pcLargeImageKey CHARACTER
The key of the large Group Image
piPosition INTEGER
The position of the Explorer Bar Group or ?
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Returns Consultingwerk.Windows.Framework.Controls.LastRecentlyUsedExplorerBarGroupController
The reference to the LastRecentlyUsedExplorerBarGroupController instance
Top

Consultingwerk.Windows.Framework.Controls.MenuStructureRibbonTabController InitializeRibbonTab (character, UltraToolbarsManager)
Purpose: Initializes a MenuStructureRibbonTabController instance
Notes:

Parameters:
pcMenuStructureGuid CHARACTER
The Guid of the Menu Structure to render
poUltraToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager instance that owns the RibbonTab
Returns Consultingwerk.Windows.Framework.Controls.MenuStructureRibbonTabController
The reference to the MenuStructureRibbonTabController instance
Top

Consultingwerk.Windows.Framework.Controls.MenuTaskListControl InitializeTaskList (character, character, character, character, character, integer, UltraExplorerBar)
Purpose: Initializes an ExplorerBarGroup with the SmartFramework MenuTaskListControl
Notes:

Parameters:
pcGroupKey CHARACTER
The key of the Group to initialize
pcGroupTitle CHARACTER
The title of the group to initialize
pcRootNodeKey CHARACTER
The key of the RootNode for the Menu
pcSmallImageKey CHARACTER
The key of the small Group Image
pcLargeImageKey CHARACTER
The key of the large Group Image
piPosition INTEGER
The position of the Explorer Bar Group or ?
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Returns Consultingwerk.Windows.Framework.Controls.MenuTaskListControl
The MenuTaskListControl instance that was created for the menu structure
Top

RemoveGroupsIfNotAuthorized (UltraExplorerBar)
Purpose: Cleanup existing groups if the user is no longer authorized
Notes:

Parameters:
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
Top

INTEGER RemoveGroupToReload (character, UltraExplorerBar, integer)
Purpose: Removes an existing UltraExplorerBarGroup to be enable reloading it.
The old index or of the group or the current index value to be added
is returned, to have the group at the same position again.
Notes:

Parameters:
pcMenuGuid CHARACTER
The key of the group to be removed
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
piIndex INTEGER
The current index when adding new groups to the UltraExplorerBar
Returns INTEGER
The index to insert the group to
Top

RenderMenuStructure (UltraExplorerBar, UltraToolbarsManager, Form)
Purpose: Render or refreshes the SmartFramework Menu displayed in an
ultraExplorerBar and ultraToolbarsManager instance
Notes:

Parameters:
poUltraExplorerBar Infragistics.Win.UltraWinExplorerBar.UltraExplorerBar
The ultraExplorerBar instance that owns the group
poUltraToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager instance that owns the RibbonTab
poForm System.Windows.Forms.Form
The form instance the menu is rendered to.


Constructor Detail
Top

MainMenuRenderer ()
Purpose: Constructor for the MainMenuRenderer class
Notes:

Top

MainMenuRenderer (BaseForm)
Purpose: Constructor for the MainMenuRenderer class
Notes:

Parameters:
poForm Consultingwerk.Forms.BaseForm
The BaseForm instance to use to load and store settings


Event Detail
Top

MenuStructureLoaded (Object, MenuStructureLoadedEventArgs)
Purpose: Raised after (re-)rendering a menu structure, with the leaf
menu functions found while rendering (SCL-5687 Quick-Launch)
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.Windows.Framework.Controls.MenuStructureLoadedEventArgs
The MenuStructureLoadedEventArgs with the data for this event


Property Detail
Top

CHARACTER ConstantExplorerBarGroups

Returns CHARACTER
Top

LOGICAL MenuTreeViewControlSortAlphabetical

Returns LOGICAL
Top

LOGICAL RenderRecentGroup

Returns LOGICAL


Temp-Table Detail


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