User Tools

Site Tools


processreportqbebutton.htm
Navigation:  Templates > Guide to all Templates > Control Templates >====== ProcessReportQBEButton ====== Previous pageReturn to chapter overviewNext page

The ProcessReportQBEButton template places a Query button on the progress window for a Process or Report procedure. This button allows the end user to apply a dynamic (run-time) filter to a report. The end user can query the underlying data and print the results of the query in a report. This control template requires a PauseButton control template on the Progress Window to allow the end user the opportunity to press the Query button.

The prompts for this control template mirror the template prompts for the BrowseQueryButton control template. See Read-Write Browse Templates'BrowseQueryButton for the deatiled information on these prompts.

The end user may provide filter criteria for zero or more columns. Additional filter criteria result in a more refined search and a smaller result set (the filter conditions are conjunctive'ANDed together).

Runtime Options

The default comparison operator is ( = ), which searches for an exact match between the Report field and the corresponding Query input field. By default all matches are case sensitive. Pressing the comparison operator button cycles through all the available operators:

Operator Filter Effect
= browsefield    equal    queryvalue
>= browsefield    greater than or equal    queryvalue
<;= browsefield    less than or equal    queryvalue
<;> browsefield    not equal     queryvalue
no filter

For string fields, you may use the following special characters in the Query input field to refine your search:

Symbol Position Filter Effect
Prefix caseless (case insensitive) search
* Prefix browsefield   contains   queryvalue
* Suffix browsefield   begins with   queryvalue

For example:

d - matches 'd' only
d* - matches 'dog', 'david'
*d - matches 'dog', 'cod'
*d - matches 'dog', 'cod', 'coD'

Upon completion of the Query dialog, the current sort order of the Report is filtered to match the query. If Query is selected again, the previous query is available by default. This allows sharing of filters between sort orders, as well as successive filter refinements.

The standard Query behavior is defined by the ABC Library's QueryClass. See QueryClass, QueryFormClass, and QueryFormVisual for more information.

The BrowseQueryButton template provides the following prompts:

General

QBE Family Specify the query family for the QBE interface. Normally this is the name of the procedure.
QBE Interface Select the query interface from the drop-down list. Choose from:
FormOne input field and button per Query field
ListOne listbox row per Query field
Auto Populate Check this box to provide a query dialog with filter criteria for each field in the Report. The input fields have the same picture token and prompt as the corresponding Report field.
Clear this box to enable the Fields button and specify custom query input fields.
Caseless Auto Populate Check this box to do case insensitive searches for each field in the Report. Clear the box to do case sensitive searches.
Fields Press this button to populate specific query input fields. You can use this option to restrict the query to some subset of Report fields, or to expand the query to include fields not in the Report. You can also implement caseless searches by default.
Field Type the field name to include in the Query dialog, or press the ellipsis button to select the field from the Select Field dialog.
Title Type the prompt or label associated with the Query field.
Picture Type a picture token for the Query field, or press the ellipsis button to select a token with the Edit Picture dialog.
Caseless Check this box to do case insensitive searches on the Query field. Clear the box to do case sensitive searches.
Disable Begins\Contains? Check this box to disable the Begins\Contains queries. This is available for the QBE form interface for any non-string field.
Retain Query This option is checked by default, and indicates that the end-user's query will remain in the Query dialog on the subsequent press of the Query button. Clear the check box to reset the Query dialog on each press of the Query button.
Use on startup Check this box to open the Query dialog before the Browse procedure opens.
Result Control Optionally select a STRING Control from the Droplist to display the filter statement created by the QBE object. A property assignment is made to the selected control (using PROP:Text), therefore it is not necessary to associate a variable with the STRING.
Auto-share between tabs Not applicable and disabled always here.
Quick QBE Support? Not applicable and disabled always here.
Submenu Icon Not applicable and disabled always here.
Query Icon Not applicable and disabled always here.

QBE Class

Select this tab to override the global Query Manager setting. See Template Overview'Classes Tab Options'Global and Local.

QBE Visual Class

Select this tab to override the global Query Manager setting. See Template Overview'Classes Tab Options'Global and Local.

processreportqbebutton.htm.txt · Last modified: 2021/04/15 15:57 (external edit)