In Standard Outline views, filters a view to display only documents from a specified category. In Calendar views, filters a view to display only documents that contain a specified string in a specified column.

Note This @function is new with Release 6.

Syntax

@SetViewInfo( [SETVIEWFILTER] ; filterString ; columnName ; isCategory [; exactMatch] )

Parameters

[SETVIEWFILTER]

Keyword. Required. Indicates you want to qualify the documents that display in a view.

Text. Serves as the key to determine which documents display in a view. If this string is present in the column specified in columnName, includes the document in the view.

Text. The programmatic name of a column. The column specified here must contain the filterString for the document to display in the view.

Note To clear the view filter, specify "" as the columnName.

Number. Boolean value. Required in a Standard Outline view; not for use in Calendar views. 1 indicates that the column in the columnName value is a category. 0 indicates that it is not. Set to 0 if using the exactMatch parameter for a Calendar view.

Number. Boolean value. Optional in a Calendar view; not for use in Standard Outline views. 1 indicates that the string in the columnName column must exactly match the string specified in filterString. 0 indicates that the filterString does not have to match exactly. For instance, if the filterString is "A," and exactMatch is set to 0, documents with "A" and "A plus" in the column specified in columnName will both be included in the view.

This @function is useful if you want to filter the documents in a view to display only a subgroup that contains specific data.

Example

Glossary