RequestColumnSearch - cCJGrid
Invokes a popup dialog that allows you to type in a search value for the passed column
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| hoCol | Handle | Column to search in |
| iKeyCode | Integer | Virtual key code (Please see the "Codejock Xtreme Report Control" documentation for more information.) |
| iKeyShift | Integer | Virtual Shift key code (Please see the "Codejock Xtreme Report Control" documentation for more information.) |
Syntax
Procedure RequestColumnSearch Handle hoCol Integer iKeyCode Integer iKeyShift
Call Example
Send RequestColumnSearch hoCol iKeyCode iKeyShift
Description
This invokes a small popup dialog that allows you to type in a search value for the passed column. This is used by the Request_Search message, which is used automatically by prompt lists (cCJGridPromptList and cDbCJGridPromptList). It can be used in customized cCJGrid and cDbCJGrid classes and objects. The key-codes passed, iKeyCode and iKeyShift, are the virtual keys provided by the grid's OnComKeyDown message and are used by prompt lists to pass the key value that invokes the list. If you pass zero for these values, no seeding occurs. If you use this on a custom basis, you will probably pass zero.
When this method is used with a static grid (cCJGrid or cDbCJGrid with pbStaticData set True), this will perform the search by calling RequestFindColumnValue. When used with static lists, this method work best when used with a sorted column, as this starts the search at the beginning and searches for the first value greater than or equal to the search value.
When used with a dynamic cDbCJGrid, it performs a database search by calling RequestColumnLookup. This can only be used on columns that have an index associated with them.