Namespace: Consultingwerk.Windows.Framework.QuickLaunch
Class 
QuickLaunchDialog Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchDialog

Inherits: Consultingwerk.Forms.BaseForm
Implements: Consultingwerk.Forms.IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs, IHasSecurityKey


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



Top Method Summary
Options Name Purpose
FillUsageCounters () Fills the usage counters of the current results
FlushPendingSearch () Runs the search for the text currently in the search box when the displayed results do not belong to that text yet
CHARACTER GetDisplayText (QuickLaunchResult) Builds the text shown in the result list for a single result - the Label, the Provider supplied Description (e.g. the owning toolbar name, or a customer's city/country/number) and the source the result came from
InitializeComponent () Initializes the Visual Design
LaunchSelected () Publishes the currently selected result as SelectedResult and closes the dialog, recording the usage for the context-aware ranking
lstResults_DoubleClick (Object, EventArgs) Event handler for the DoubleClick event of lstResults - launches the double-clicked result
MoveSelection (integer) Moves the result list selection by piDelta, clamped to the available range
OnFormClosed (FormClosedEventArgs) Releases the debounce timer before the form is closed and deleted
PerformSearch (character) Raises QuickLaunchSearchEvent:SearchRequested and populates the result list with the (rank-sorted) responses
QuickLaunchDialog_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown event of the dialog (KeyPreview is true, so this fires regardless of which control has focus) - Up/Down move the selection, Enter launches the selected result, Escape closes the dialog
QuickLaunchDialog_Load (Object, EventArgs) Event handler for the Load event of the dialog - runs the initial, empty-term search
ReleaseSearchTimer () Stops, unsubscribes and releases the debounce timer
SearchTimer_Tick (Object, EventArgs) Event handler for the Tick event of the debounce timer - runs the search for the current text
SortResultsByRank () Sorts the current results into display order
LOGICAL SortsBefore (QuickLaunchResult, QuickLaunchResult) Returns whether the first result belongs before the second one
txtSearch_TextChanged (Object, EventArgs) Event handler for the TextChanged event of txtSearch - (re-)starts the debounce timer

Top Constructor Summary
Options Name Purpose
QuickLaunchDialog (character, Form) Constructor for the QuickLaunchDialog class

Top Property Summary
Options Name Purpose
INTEGER MaxTotalResults
INTEGER SearchDelayMilliseconds
Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult SelectedResult


Method Detail
Top

FillUsageCounters ()
Purpose: Fills the usage counters of the current results
Notes: Done centrally here rather than in every Provider - a Provider
only scores how well its entry matches the search term, the
ranking against previous usage belongs to the dialog

Top

FlushPendingSearch ()
Purpose: Runs the search for the text currently in the search box when
the displayed results do not belong to that text yet
Notes: Covers both a still pending debounce timer and the case where
the user typed and pressed Enter so quickly that the timer
never fired at all. Mirrors how SmartLookup flushes its
pending lookup rather than acting on stale results

Top

CHARACTER GetDisplayText (QuickLaunchResult)
Purpose: Builds the text shown in the result list for a single result -
the Label, the Provider supplied Description (e.g. the owning
toolbar name, or a customer's city/country/number) and the
source the result came from
Notes:

Parameters:
poResult Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult
The QuickLaunchResult to build the display text for
Returns CHARACTER
The text to display in the result list
Top

InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

LaunchSelected ()
Purpose: Publishes the currently selected result as SelectedResult and
closes the dialog, recording the usage for the context-aware
ranking
Notes: Executing the result is left to the caller of the dialog - see
QuickLaunchShortcutHandler:HandleKey HandleKey

Top

lstResults_DoubleClick (Object, EventArgs)
Purpose: Event handler for the DoubleClick event of lstResults -
launches the double-clicked result
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

MoveSelection (integer)
Purpose: Moves the result list selection by piDelta, clamped to the
available range
Notes:

Parameters:
piDelta INTEGER
The number of rows to move (negative moves up)
Top

OnFormClosed (FormClosedEventArgs)
Purpose: Releases the debounce timer before the form is closed and
deleted
Notes:

Parameters:
e System.Windows.Forms.FormClosedEventArgs
The System.Windows.Forms.FormClosedEventArgs with the data for this event
Top

PerformSearch (character)
Purpose: Raises QuickLaunchSearchEvent:SearchRequested and populates
the result list with the (rank-sorted) responses
Notes:

Parameters:
pcSearchTerm CHARACTER
The search term to search for, or "":u
Top

QuickLaunchDialog_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown event of the dialog (KeyPreview
is true, so this fires regardless of which control has
focus) - Up/Down move the selection, Enter launches the
selected result, Escape closes the dialog
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The System.Windows.Forms.KeyEventArgs with the data for this event
Top

QuickLaunchDialog_Load (Object, EventArgs)
Purpose: Event handler for the Load event of the dialog - runs the
initial, empty-term search
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

ReleaseSearchTimer ()
Purpose: Stops, unsubscribes and releases the debounce timer
Notes: Must run before the form is disposed - a still enabled timer
would fire its Tick against the disposed controls (and the
deleted form instance) up to SearchDelayMilliseconds after
the dialog was closed

Top

SearchTimer_Tick (Object, EventArgs)
Purpose: Event handler for the Tick event of the debounce timer -
runs the search for the current text
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

SortResultsByRank ()
Purpose: Sorts the current results into display order
Notes: A plain in-place bubble sort - the result set is small
(capped by MaxTotalResults / per-Provider caps), so this is
simpler than pulling in a general purpose sort helper

Top

LOGICAL SortsBefore (QuickLaunchResult, QuickLaunchResult)
Purpose: Returns whether the first result belongs before the second one
Notes: Match quality first, then the context specific usage counter,
then the context independent one, then alphabetically. Match
quality deliberately outranks usage - a single earlier launch
of a barely matching entry must not push it above an exact
match

Parameters:
poFirst Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult
The result to compare
poSecond Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult
The result to compare against
Returns LOGICAL
True when poFirst belongs before poSecond
Top

txtSearch_TextChanged (Object, EventArgs)
Purpose: Event handler for the TextChanged event of txtSearch -
(re-)starts the debounce timer
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event


Constructor Detail
Top

QuickLaunchDialog (character, Form)
Purpose: Constructor for the QuickLaunchDialog class
Notes:
dialog was invoked (captured by the caller
before this dialog takes focus)

Parameters:
pcContextFormName CHARACTER
The Name of the Form that was active when the
poContextForm System.Windows.Forms.Form
The Form that was active when the dialog was invoked


Property Detail
Top

INTEGER MaxTotalResults

Returns INTEGER
Top

INTEGER SearchDelayMilliseconds

Returns INTEGER
Top

Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult SelectedResult

Returns Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult


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