ControlContext :: searchKey - Search key in control data area
The function looks for the passed text (sKey) in a list or in a text field.
Searching in a list tries to locate a list entry with the given key value by searching for the key value in the the order column of the list.
When bWord is set to true, text or list entries containing the complete key are selected, only. Otherwise any list entry or text item starting with the passed key value is accepted. In order to perform case sensitive search, bCareSensitive has to be set to true.
Searching in text fields looks for words or text strings contained in the text. When the text could be located, it will be high lighted.
Searching will start from the current position, when bCurrent is set to true. Otherwise, searching starts from the beginning of the list or text field.
Implementation details
- sKey
- Key string
The key string is a value to be searched in a list or text field.
- bCurrent
- Start processing at current position
Processing (e.g. searching) a text or list starts from beginning when this option is not set (false) or from the current position, when this option is set (true).
- bCaseSensitive
- Case sensitive
When this option is set (true), processing (e.g. searching) a list or text will accept cases (case sensitive). When this option is not set (false), the process will work case insensitive.
- bWord
- Words only
When this option is set (true), the process (e.g. search) will look for whole words, only. Otherwise (false), the process accepts any macing text string.