Namespace: Consultingwerk.WindowIntegrationKit
Class 
SampleRibbonBuilder Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.WindowIntegrationKit.SampleRibbonBuilder

Inherits: Progress.Lang.Object
Implements: Consultingwerk.WindowIntegrationKit.IRibbonBuilder

File:SampleRibbonBuilder
Purpose:Sample IRibbonBuilder implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Feb 28 15:51:32 CET 2012
Notes:Used in the WinKit after the UltraToolbarsHelper routines
have built Infragistics Toolbars and menus to turn

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



Top Method Summary
Options Name Purpose
# AddMainMenuToLeftApplicationMenu (UltraToolbarsManager, handle) Adds the Tools contained in the MainMenuToolbar to the left application menu of the Ribbon
+ BuildRibbonForToolbar (UltraToolbarsManager, handle) Builds a Ribbon for a toolbar manager instance
# Infragistics.Win.UltraWinToolbars.RibbonGroup CreateGroup (character, RibbonTab) Creates a Ribbon Group
# Infragistics.Win.UltraWinToolbars.RibbonTab CreateTab (character, UltraToolbarsManager) Creates a Ribbon Tab
# Infragistics.Win.UltraWinToolbars.ToolBase CreateTool (character, ToolsCollection) Creates a Tool Instance on the Ribbon
# InsertGroup (character, character) Inserts a Ribbon Group in the definition
# InsertGroup (character, character, integer) Inserts a Ribbon Group in the definition
# InsertTab (character) Inserts a Ribbon Tag in the definition
# InsertTab (character, integer) Inserts a Ribbon Tag in the definition
# InsertTool (character) Inserts a Tool in the definition
# InsertTool (character, character, character, integer) Inserts a Tool in the definition


Method Detail
Top

PROTECTED AddMainMenuToLeftApplicationMenu (UltraToolbarsManager, handle)
Purpose: Adds the Tools contained in the MainMenuToolbar to the left
application menu of the Ribbon
Notes: Executes the function getWinKitExcludeMenuItemsFromRibbon in the callback
procedure to return a list of tools (sub menu names) that should be
excluded from the application menu

Parameters:
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The Infragistics.Win.UltraWinToolbars.UltraToolbarsManager instance to build a Ribbon for
phCallbackProcedure HANDLE
The PROCEDURE to use for callbacks
Top

PUBLIC BuildRibbonForToolbar (UltraToolbarsManager, handle)
Purpose: Builds a Ribbon for a toolbar manager instance
Notes: Used in the WinKit after the UltraToolbarsHelper routines have built
Infragistics Toolbars and menus to turn

Parameters:
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The Infragistics.Win.UltraWinToolbars.UltraToolbarsManager instance to build a Ribbon for
phCallbackProcedure HANDLE
The PROCEDURE to use for callbacks
Top

PROTECTED Infragistics.Win.UltraWinToolbars.RibbonGroup CreateGroup (character, RibbonTab)
Purpose: Creates a Ribbon Group
Notes:

Parameters:
pcGroupKey CHARACTER
The key for the group to create
poTab Infragistics.Win.UltraWinToolbars.RibbonTab
The reference to the parent RibbonTab
Returns Infragistics.Win.UltraWinToolbars.RibbonGroup
The reference to the created RibbonGroup
Top

PROTECTED Infragistics.Win.UltraWinToolbars.RibbonTab CreateTab (character, UltraToolbarsManager)
Purpose: Creates a Ribbon Tab
Notes:

Parameters:
pcTabKey CHARACTER
The key for the tab to create
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the parent UltraToolbarsManager
Returns Infragistics.Win.UltraWinToolbars.RibbonTab
The reference to the created RibbonTab
Top

PROTECTED Infragistics.Win.UltraWinToolbars.ToolBase CreateTool (character, ToolsCollection)
Purpose: Creates a Tool Instance on the Ribbon
Notes:

Parameters:
pcToolKey CHARACTER
The key for the tool to create an instance of
poToolsCollection Infragistics.Win.UltraWinToolbars.ToolsCollection
The reference to the parent ToolsCollection (e.g. RibbonGroup:Tools)
Returns Infragistics.Win.UltraWinToolbars.ToolBase
The reference to the created Tool
Top

PROTECTED InsertGroup (character, character)
Purpose: Inserts a Ribbon Group in the definition
Notes:

Parameters:
pcTabKey CHARACTER
The key of the containing RibbonTab
pcGroupKey CHARACTER
The key of the group to create
Top

PROTECTED InsertGroup (character, character, integer)
Purpose: Inserts a Ribbon Group in the definition
Notes: Alternative Groups in Tab ? are:
ToolAreaLeft, ToolAreaRight, FooterToolbar, TabItemToolbar

Parameters:
pcTabKey CHARACTER
The key of the containing RibbonTab
pcGroupKey CHARACTER
The key of the group to create
piGroupSort INTEGER
The sort weight for the group to create
Top

PROTECTED InsertTab (character)
Purpose: Inserts a Ribbon Tag in the definition
Notes:

Parameters:
pcTabKey CHARACTER
The key of the Tab to create
Top

PROTECTED InsertTab (character, integer)
Purpose: Inserts a Ribbon Tag in the definition
Notes:

Parameters:
pcTabKey CHARACTER
The key of the Tab to create
piTabSort INTEGER
The sort weight for the tab to create
Top

PROTECTED InsertTool (character)
Purpose: Inserts a Tool in the definition
Notes:

Parameters:
pcToolKey CHARACTER
The key of the Tool to create
Top

PROTECTED InsertTool (character, character, character, integer)
Purpose: Inserts a Tool in the definition
Notes:

Parameters:
pcTabKey CHARACTER
The key of the containing Ribbon Tab
pcGroupKey CHARACTER
The key of the containing Ribbon Group
pcToolKey CHARACTER
The key of the Tool to create
piToolSort INTEGER
The sort weight of the tool to create


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:41:17