Search_Mode - DfBaseList
Determines how users may move the selection cursor to a choice by use of (alphanumeric) keys matching the content of the choice
Type: Property
Access: Read/Write
Data Type: Integer
Parameters: None
Syntax
Property Integer Search_Mode
| Access Type | Syntax |
|---|---|
| Read Access: | Get Search_Mode to IntegerVariable |
| Write Access: | Set Search_Mode to IntegerVariable/Value |
Description
Search_Mode determines how users may move the selection cursor to a choice by use of (alphanumeric) keys matching the content of the choice. By default, dbList objects are set to incremental search. Also by default, Popup_Search_State is True in dbList objects, which causes a search box to pop up when the user begins typing, then finds the first entry matching the entered text. In order to utilize Search_Mode, Popup_Search_State must be set to False.
| Value | Description |
|---|---|
| Possible ValuesValueDescription | CapitalMoves the cursor to the first choice beyond the cursor position in which the input letter is present in uppercase. Examples include the F in File and the X in eXit. Only the first capital letter in the choice content is respected. The search is insensitive to the case of the letter input. Capital letter search is not supported for virtual lists except within the current display page. |
| First_Character | Moves the cursor to the next choice beyond the cursor whose content begins with the input character. The search is case-insensitive in all respects. Starting from the top of a list made up of File, forMat, and eXit, repeated pressing of F or f would place the cursor first on File, then on forMat, and never on eXit. In a list of choices made up exclusively of capital letters, there is no difference between first_character and capital search modes. A first character search mechanism is available for virtual lists, with one exception: pressing the key for the same character repeatedly does not advance to the next item with the same first character for virtual lists (it does for non-virtual lists). This is a known limitation. |
| Incremental (default) | Moves the cursor to the next choice whose beginning characters match the sequence of characters input by users since the cursor entered the list. Unless the item the cursor is on already matches, each character entered moves the cursor to the next item whose beginning characters match, if any. Pressing backspace removes the last character typed and moves the cursor back to the previous choice that it was on. The incremental search mechanism permits incremental searching on parent files of the main file of the list. |
| No_Search | Causes the object to ignore all alphanumeric keys and respond to standard navigation keys only. |
Sample
Set Search_Mode to No_Search
Sample
If (Search_Mode = Capital) Send SomeMessage