Favorite property

The Favorite property is a read-write string property that gets or sets the name of the current query filter favorite.

Syntax

QueryFilterName = AlarmClient.Favorite;

AlarmClient.Favorite = QueryFilterName;

Parameters

QueryFilterName

The name of a query filter favorite.

Example

The following example sets the current Alarm Control grid to the Query Filter Favorite with the name "All Hi Priority Alarms".

AlarmClient1.Favorite = "All Hi Priority Alarms";

Remarks

You can also use this property to reset the currently used query filter to its default with the following script:

AlarmClient.Favorite = "Default";

The Favorite property executes as a query to retain previous release default behavior. If you want to execute the query/filter as a filter only, then use the RunQuery() method.