TakeKey (process an alerted keystroke:StepLocatorClass)


Top  Previous  Next

 

TakeKey, DERIVED

The TakeKey method processes an alerted keystroke for the LIST control and returns a value indicating whether the browse list display must change.

 

By default, all alphanumeric keys are alerted for LIST controls.

Implementation:

The TakeKey method primes the FreeElement property with the appropriate search value, 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:

   IF SELF.Sort.Locator.TakeKey() !process the search key

    SELF.Reset(1)                 ! if valid, reset the view

    SELF.ResetQueue( Reset:Done ) ! and the browse queue

   END

See Also:     FreeElement