Navigation: ABC Library Reference > IncrementalLocatorClass > IncrementalLocatorClass Methods >====== TakeKey (process an alerted keystroke:IncrementalLocatorClass) ====== | |
TakeKey, VIRTUAL
The TakeKey method processes an alerted locator keystroke for the LIST control that displays the data to be searched, and returns a value indicating whether the browse display should change.
By default, all alphanumeric keys are alerted for LIST controls.
Implementation:
The TakeKey method adds to or subtracts from the search value (the Shadow property) based on the end user's keystrokes, then returns one (1) if a new search is required or returns zero (0) if no new search is required. A search is required only if the keystroke is a valid search character.
Return Data Type: BYTE
Example:
CheckLocator ROUTINE
IF SELF.Sort.Locator.TakeKey() !handle locator alerted keys
SELF.Reset(1) !if search needed, reset view
SELF.ResetQueue(Reset:Done) ! and relead queue
ELSE !if no search needed
SELF.ListControl{PROP:Selected}=SELF.CurrentChoice!highlight selected list item
END
See Also: EntryLocatorClass.Shadow