Namespace: Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar
Class 
RibbonRenderer Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.RibbonRenderer

Inherits: Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Implements: Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.IRibbonRenderer, Ccs.Common.IService

File:RibbonRenderer
Purpose:Renders a Ribbon based on the list of toolbar buttons
Author(s):Mike Fechner/ Consultingwerk Ltd.
Created:Sat Jun 15 14:26:36 CEST 2019

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



Top Method Summary
Options Name Purpose
+ dispose () Disposes the Service
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
# Progress.Json.ObjectModel.JsonObject GetJsonObject (character, character) Locates the Button/Group/Tab definition
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
+ initialize () Initializes the Service
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
# System.Drawing.Bitmap LoadImage (character, character) Loads an Image
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
# RenderButton (character, DynamicForm, SmartToolbarController) Renders a ribbon buttons based on the given identifier
+ RenderRibbon (DynamicForm, SmartToolbarController, character) Renders a Ribbon
# Infragistics.Win.UltraWinToolbars.RibbonGroup RenderRibbonGroup (character, SmartToolbarController) Renders a Ribbon Group or returns an existing group
# Infragistics.Win.UltraWinToolbars.RibbonTab RenderRibbonTab (character, SmartToolbarController) Renders a Ribbon Tabs or returns an existing tab
# Infragistics.Win.UltraWinToolbars.ToolBase RenderRootTool (JsonObject, character, DynamicForm, UltraToolbarsManager) Renders a RootTool
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
# SetShortcutForTool (character, SharedProps, JsonObject) Sets the shortcut for a ButtonTool
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
# UpdateButtonProperties (character, SharedProps, JsonObject) Updates SharedProps of a Button Tool
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer

Top Property Summary
Options Name Purpose
# Progress.Json.ObjectModel.JsonObject JsonObjects
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer


Method Detail
Top

PUBLIC dispose ()
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Disposes the Service
Notes:

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetJsonObject (character, character)
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Locates the Button/Group/Tab definition
Notes:

Parameters:
pcType CHARACTER
The type of object to look for (tools, groups, tabs)
pcId CHARACTER
The Id of the object to look for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the Button/Group/Tab definition
Top

PUBLIC initialize ()
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Initializes the Service
Notes:

Top

PROTECTED System.Drawing.Bitmap LoadImage (character, character)
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Loads an Image
Notes: Provides error handling when the image cannot be found

Parameters:
pcName CHARACTER
The name of the toolbar button
pcImageKey CHARACTER
The key (filename) of the image
Returns System.Drawing.Bitmap
The System.Drawing.Bitmap reference
Top

PROTECTED RenderButton (character, DynamicForm, SmartToolbarController)
Purpose: Renders a ribbon buttons based on the given identifier
Notes:

Parameters:
pcButtonId CHARACTER
The identifier of the button to render
poForm Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
The reference to the dynamic form
poToolbarController Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController
Top

PUBLIC RenderRibbon (DynamicForm, SmartToolbarController, character)
Purpose: Renders a Ribbon
Notes:

Parameters:
poForm Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
The reference to the dynamic form
poToolbarController Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController
pcToolbarButtons CHARACTER
The list of the toolbar buttons to render
Top

PROTECTED Infragistics.Win.UltraWinToolbars.RibbonGroup RenderRibbonGroup (character, SmartToolbarController)
Purpose: Renders a Ribbon Group or returns an existing group
Notes:

Parameters:
pcGroupId CHARACTER
The ID of the Ribbon Group
poToolbarController Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController
Returns Infragistics.Win.UltraWinToolbars.RibbonGroup
The RibbonGroup reference
Top

PROTECTED Infragistics.Win.UltraWinToolbars.RibbonTab RenderRibbonTab (character, SmartToolbarController)
Purpose: Renders a Ribbon Tabs or returns an existing tab
Notes:

Parameters:
pcTabId CHARACTER
The ID of the Ribbon Tab
poToolbarController Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController
Returns Infragistics.Win.UltraWinToolbars.RibbonTab
The RibbonTab reference
Top

PROTECTED Infragistics.Win.UltraWinToolbars.ToolBase RenderRootTool (JsonObject, character, DynamicForm, UltraToolbarsManager)
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Renders a RootTool
Notes: Button or ComboBox Tool

Parameters:
poButton Progress.Json.ObjectModel.JsonObject
The Reference to the JSON Object representing the Button definition
pcName CHARACTER
The name of the Button to render
poForm Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
The reference to the DynamicForm instance
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager
Returns Infragistics.Win.UltraWinToolbars.ToolBase
The instance of the ToolBase
Top

PROTECTED SetShortcutForTool (character, SharedProps, JsonObject)
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Sets the shortcut for a ButtonTool
Notes:

Parameters:
pcName CHARACTER
The name of the toolbar button to render
poSharedProps Infragistics.Win.UltraWinToolbars.SharedProps
The reference to the SharedProps of the button tool
poButton Progress.Json.ObjectModel.JsonObject
The JSON definition of the button
Top

PROTECTED UpdateButtonProperties (character, SharedProps, JsonObject)
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer
Purpose: Updates SharedProps of a Button Tool
Notes:

Parameters:
pcName CHARACTER
The name of the button
poSharedProps Infragistics.Win.UltraWinToolbars.SharedProps
The reference to the SharedProps of the button tool
poButton Progress.Json.ObjectModel.JsonObject
The JSON definition of the button


Property Detail
Top

PROTECTED Progress.Json.ObjectModel.JsonObject JsonObjects
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.SmartToolbarControllerRenderer

Returns Progress.Json.ObjectModel.JsonObject


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:22:18