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

File:MainMenuRenderer
Purpose:Renders the Main Menu and Ribbon to be displayed from
SmartFramework. The reference implementation can be seen
in Consultingwerk.Windows.Framework.Reference.MainMenuForm.
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Wed May 25 16:52:01 CEST 2016

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# InitializeExplorerBarGroup (character, character, character, character, character, integer, logical, UltraExplorerBar) Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
# InitializeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with the SmartFramework MenuTreeViewControl
# InitializeNativeExplorerBarGroup (character, character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with the native Explorer Bar Items
# InitializeRecentlyUsedMenuItemsGroup (character, character, character, character, integer, UltraExplorerBar) Initializes an ExplorerBarGroup with recently used menu items
# InitializeRibbonTab (character, UltraToolbarsManager) Initializes a MenuStructureRibbonTabController instance
# 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 Property Summary
Options Name Purpose
+ CHARACTER ConstantExplorerBarGroups Comma delimeted list of constant ExplorerBarGroups that do not get removed if the user is not authorized to see them
+ LOGICAL MenuTreeViewControlSortAlphabetical Defines sorting of MenuTreeViewControl. When menu should be sorted by alphabet and not by menu structure provider
+ LOGICAL RenderRecentGroup Indicates if the list of last recently used MenuItems should be rendered


Method Detail
Top

PROTECTED 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
Top

PROTECTED 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
Top

PROTECTED 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
Top

PROTECTED 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
Top

PROTECTED 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 RibonTab
Top

PROTECTED 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
Top

PROTECTED 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

PROTECTED 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

PUBLIC 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 RibonTab
poForm System.Windows.Forms.Form
The form instance the menu is rendered to.


Property Detail
Top

PUBLIC CHARACTER ConstantExplorerBarGroups
Purpose: Comma delimeted list of constant ExplorerBarGroups that do not get
removed if the user is not authorized to see them
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL MenuTreeViewControlSortAlphabetical
Purpose: Defines sorting of MenuTreeViewControl. When menu should be sorted
by alphabet and not by menu structure provider
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL RenderRecentGroup
Purpose: Indicates if the list of last recently used MenuItems should be rendered
Notes:

Returns LOGICAL


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:49:16