Clarion Community Help

TakeAccepted, VIRTUAL

The TakeAccepted method processes the accepted locator value and returns a value indicating whether the BrowseClass list display should be updated. A return value of one (1 or True) indicates the list should be refreshed; a return value of zero (0 of False) indicates no refresh is needed.

This method is only appropriate for LocatorClass objects with locator controls that accept user input; for example, entry controls, combo controls, or spin controls.

A locator value is accepted when the end user changes the locator value, then TABS off the locator control or otherwise switches focus to another control on the same window.

Implementation:

The TakeAccepted method primes the FreeElement property with the appropriate search value. If there is a search value, TakeAccepted calls the UpdateWindow method to apply the search value.

Return Data Type:     BYTE

Example:

BrowseClass.TakeAcceptedLocator PROCEDURE !process an accepted locator entry

CODE

IF ~SELF.Sort.Locator &= NULL AND ACCEPTED() = SELF.Sort.Locator.Control

 IF SELF.Sort.Locator.TakeAccepted()     !call locator take accepted method

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

  SELECT(SELF.ListControl)               !focus on the browse list control

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

  IF ~SELF.Sort.Locator &= NULL          !if locator is present

   SELF.Sort.Locator.Reset               !match search value to actual record

  END

 END

END

See Also:     FreeElement