SetFieldFilter

Syntax

SetFieldFilterResult SetFieldFilter(OdId tOb, SetFieldFilterArg tArg)

Parameters

mon. Moniker of opened relational object instance.

tArg. Operation execution parameters.

Description

The SetFieldFilter operation determines autofilter filtering settings by field values.

Comments

Before executing this operation, the CreateFieldFilterState operation must be executed for the corresponding field. To execute the SetFieldFilter operation, in the tOb field specify moniker of opened relational object instance, and in the tArg field specify autofilter settings parameters. Autofilter settings use the field values that can be obtained using the GetFieldValues operation. The moniker can be obtained on executing the OpenTable, OpenQuery operations. In tArg one should also set moniker of the relation object cache that can be obtained using the GetTable/GetQuery operations with the cachedDataset field specified in the pattern.

The operation result determines whether autofilter settings were changed successfully.

The made changes are applied after executing the CloseFieldFilterState operation. To get filtered records from the relational data source, call the GetTable/GetQuery operations again.

Example

Various methods of using the operation are given in the following examples:

Example name

Resetting elements selected in autofilter

Setting element selected in autofilter