Namespace: Consultingwerk.Windows.Framework.QuickLaunch.Providers
Class 
RibbonButtonSearchProvider Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.QuickLaunch.Providers.RibbonButtonSearchProvider

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Windows.Framework.QuickLaunch.IQuickLaunchResultProvider


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



Top Method Summary
Options Name Purpose
CollectFromControls (Control+ControlCollection) Walks a control collection depth first, contributing the Ribbon of every UltraToolbarsDockArea's ToolbarsManager it finds
CollectFromRibbon (SmartToolbarController) Contributes a result for every enabled tool on every visible group of every visible tab of the manager's Ribbon
ContributeTool (SmartToolbarController, RibbonTab, RibbonGroup, ToolBase) Contributes a single enabled, captioned Ribbon tool as a result
dispose () Unsubscribes from the events this Provider subscribed to, per Ccs.Common.IService
ExecuteResult (character, Object) Performs the click of the Ribbon button this result was produced for
initialize () Subscribes to the events this Provider needs, per Ccs.Common.IService
OnSearchRequested (Object, QuickLaunchSearchEventArgs) Event handler for QuickLaunchSearchEvent:SearchRequested - adds the matching enabled Ribbon buttons of the context screen

Top Property Summary
Options Name Purpose
INTEGER MaxRibbonResults


Method Detail
Top

CollectFromControls (Control+ControlCollection)
Purpose: Walks a control collection depth first, contributing the Ribbon
of every UltraToolbarsDockArea's ToolbarsManager it finds
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The control collection to walk
Top

CollectFromRibbon (SmartToolbarController)
Purpose: Contributes a result for every enabled tool on every visible
group of every visible tab of the manager's Ribbon
Notes: Managers without a Ribbon (plain toolbar managers) are skipped -
those are covered by ToolbarButtonSearchProvider

Parameters:
poManager Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The SmartToolbarController to read the Ribbon from
Top

ContributeTool (SmartToolbarController, RibbonTab, RibbonGroup, ToolBase)
Purpose: Contributes a single enabled, captioned Ribbon tool as a result
Notes:

Parameters:
poManager Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The SmartToolbarController owning the tool
poTab Infragistics.Win.UltraWinToolbars.RibbonTab
The Ribbon tab the tool is placed on
poGroup Infragistics.Win.UltraWinToolbars.RibbonGroup
The Ribbon group the tool is placed in
poTool Infragistics.Win.UltraWinToolbars.ToolBase
The tool to contribute
Top

dispose ()
Purpose: Unsubscribes from the events this Provider subscribed to, per
Ccs.Common.IService
Notes:

Top

ExecuteResult (character, Object)
Purpose: Performs the click of the Ribbon button this result was
produced for
Notes: The tool is looked up again rather than cached on the result -
the screen may have changed during the search debounce delay

Parameters:
pcActionKey CHARACTER
The tool key, as set by this Provider
poPayload Progress.Lang.Object
The SmartToolbarController owning the tool
Top

initialize ()
Purpose: Subscribes to the events this Provider needs, per Ccs.Common.IService
Notes:

Top

OnSearchRequested (Object, QuickLaunchSearchEventArgs)
Purpose: Event handler for QuickLaunchSearchEvent:SearchRequested - adds
the matching enabled Ribbon buttons of the context screen
Notes:

Parameters:
poSender Progress.Lang.Object
The reference to the object that raised the event
poEventArgs Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchSearchEventArgs
The QuickLaunchSearchEventArgs with the data for this event


Property Detail
Top

INTEGER MaxRibbonResults

Returns INTEGER


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