peRequestFindMode - cWebList
Determines how request finds should be applied to a web grid
Type: Property
Access: Read/Write
Data Type: Integer
Parameters: None
Syntax
Property Integer peRequestFindMode
| Access Type | Syntax |
|---|---|
| Read Access: | Get peRequestFindMode to IntegerVariable |
| Write Access: | Set peRequestFindMode to IntegerVariable/Value |
Description
The Request_Find method can be used in different ways in web grids. A find can be used to:
-
Find a new main table record, which will refresh the grid around this record.
-
Find a parent table record, which will change parent records in the existing row.
-
Find a parent table record, find the index in the main table that relates to it and refresh the grid around this record (a superfind).
Depending on how you are using your grid, you may want different combinations of these find capabilities. The peRequestFindMode property lets you control this.
The following modes are supported:
| Constant | Meaning |
|---|---|
| rfmFindAll | Find on all main and parent table fields. If the find is based on an index in the grid's main table, the grid is refreshed. If the find is based on a parent table, the parent record is found within the existing row (i.e., the parent record is changed). If there is no index for the column, nothing happens. This is the default for cWebList objects. |
| rfmFindMainOnly | Find only on the grid's main-table and refresh the table. Do not perform parent finds. |
| rfmFindMainSuper | Find on the grid's main table and perform superfinds on the parent tables. A parent superfind occurs if the parent field has an index, and the main table has a indexed relationship to this parent. The parent record is found, the first related main table record is found and the grid is refreshed. This is useful with prompt lists and this is the default for cDbCJGridPromptList objects. |
| rfmFindParentOnly | Only find on parent tables and do regular parent finds (i.e., just change the parent record). This might often be a good choice for data entry grids where you only wish to support selecting and changing parent records within a single row. |
| rfmFindNone | All finding is disabled. Sometimes finding just gets in the way. |
If a table refresh occurs, the refresh is based on the table's current index ordering and not index used to perform the find.
The find operations (GE, GT, LT, First_Record and Last_Record) are usually bound to menus, toolbars and keys. These all call Request_Find, which is the standard message used for finding in all DEOs. In grids (cWebGrid), Request_Find uses peRequestFindMode to determine how the find should proceed.