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

Inherits: Consultingwerk.EventArgs


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



Top Method Summary
Options Name Purpose
AddBackendQuery (QuickLaunchBackendQuery) Declares a Business Entity query to be executed together with the queries of the other Providers, in a single backend round trip (SCL-5688)
AddResult (QuickLaunchResult) Adds a result contributed by a Provider
FlushBackendQueries () Executes the queries declared through AddBackendQuery and lets the Providers that declared them contribute their results
Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult GetResults () Returns the completed result set of this search

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

Top Property Summary
Options Name Purpose
System.Windows.Forms.Form ContextForm
CHARACTER ContextFormName
INTEGER MaxResults
CHARACTER SearchTerm


Method Detail
Top

AddBackendQuery (QuickLaunchBackendQuery)
Purpose: Declares a Business Entity query to be executed together with
the queries of the other Providers, in a single backend round
trip (SCL-5688)
Notes: Purely optional - a Provider that would rather make its own
backend call in its search event handler still may. The
declared queries are executed when the Quick-Launch dialog
asks for the results

Parameters:
poQuery Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchBackendQuery
The QuickLaunchBackendQuery to execute
Top

AddResult (QuickLaunchResult)
Purpose: Adds a result contributed by a Provider
Notes:

Parameters:
poResult Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult
The QuickLaunchResult to add
Top

FlushBackendQueries ()
Purpose: Executes the queries declared through AddBackendQuery and
lets the Providers that declared them contribute their results
Notes:

Top

Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult GetResults ()
Purpose: Returns the completed result set of this search
Notes: Executing the declared backend queries is deferred until
here, so that all Providers have had the chance to declare
theirs and the whole batch travels to the backend in one
round trip. Calling the method again does not repeat that
call

Returns Consultingwerk.Windows.Framework.QuickLaunch.QuickLaunchResult
The array of QuickLaunchResult instances contributed by all Providers


Constructor Detail
Top

QuickLaunchSearchEventArgs (character, integer, character, Form)
Purpose: Constructor for the QuickLaunchSearchEventArgs class
Notes:

Parameters:
pcSearchTerm CHARACTER
The search term the user has typed, or "":U
piMaxResults INTEGER
A hint for the maximum number of results a Provider should contribute
pcContextFormName CHARACTER
The Name of the Form active when the dialog was invoked
poContextForm System.Windows.Forms.Form
The Form active when the dialog was invoked, or ?


Property Detail
Top

System.Windows.Forms.Form ContextForm

Returns System.Windows.Forms.Form
Top

CHARACTER ContextFormName

Returns CHARACTER
Top

INTEGER MaxResults

Returns INTEGER
Top

CHARACTER SearchTerm

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:37:41