Puts a rowset in Filter mode, allowing the entry of filter criteria.


<oRef>.beginFilter( )


The rowset you want to put in Filter mode.

Property of



Rowset objects support a Filter mode in which values can be assigned to Field objects and then used to filter the rows in a rowset to show only those rows with matching values. beginFilter( ) puts the rowset in Filter mode and applyFilter( ) applies the filter values. clearFilter( ) cancels the filter. 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 filter-by-form feature in your application.

When beginFilter( ) 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 Filter mode, call the abandon( ) method.

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

To filter rows with a condition without using Filter mode, set the rowset’s filter property. See the filter property for more information on how filters are applied to data. To filter rows with dBL code instead of or in addition to Filter mode, use the canGetRow event.