beginLocate( )

Topic group Related topics

Puts a rowset in Locate mode, allowing the entry of search criteria.

Syntax

<oRef>.beginLocate( )

<oRef>

The rowset you want to put in Locate mode.

Property of

Rowset

Description

Rowset objects support a Locate mode in which values can be assigned to Field objects and then used to find rows in a rowset that contain matching values. beginLocate( ) puts the rowset in Locate mode and applyLocate( ) finds the first matching row. locateNext( ) finds other matching rows. Because dataLinked controls on forms write to the value properties of Field objects, a call to those three methods are all you need to implement a search-by-form feature in your application.

When beginLocate( ) is called, the row buffer is cleared. Values that are set either through dataLinked controls or by assigning values to value properties are used for matching. Fields whose value property is left blank are not considered. To cancel Locate mode, call the abandon( ) method.

If navigation is attempted while in Locate mode, Locate mode is canceled and the navigation occurs, relative to the position of the row cursor at the time beginLocate( ) was called.