Description

Enables alerts and setting of triggers when added to either the relevant BaseQuery or DirectoryStyle. The RefreshOptions value on the DirectoryStyle takes precedence over the value set on the BaseQuery.

The RefreshOptions value must be one of the following values:

•Default: the default refresh option is used as specified by the AlertManager.DefaultRefreshOptions property available to the AddIns. The default is to response to internal alerts.

•None: forces the associated listings to ignore all alerts.

•IndicateOnAlert: if the listing is affected by an alert, a visual indicator is displayed but the refresh of the listing is achieved manually.

•RefreshOnAlert: if the listing is affected by an alert, the listing is refreshed automatically

•RefreshOnInternalAlert: if the listing is affected by an alert, the listing is refreshed automatically. This setting does not set the external alerts.

The IndicateOnAlert, RefreshOnAlert, RefreshOnInternalAlert options can be combined with the following:

•MonitorReferencing: monitor the object's containers. A trigger is setup for each of the listings containers.

•MonitorObject: monitor the objects in the listing. A trigger is setup for a modification on any of the object's properties.

•MonitorCheckInCheckOut: monitor the objects in the listing for checkin/checkout activity. This is ignored if the directory style does not display checkin/checkout activity.

•MonitorAll: a combination of three above options.

About internal and external alerts

Internal alerts are raised programmatically by the RaiseInternalAlert method called by the application or AddIn code when (say) a page or a story has been modified; this means that the listings will refresh that are related to the page or story and so display the changes. If affects only the calling application.

External alerts are raised by the server when an object is modified and notifications are sent to the applications that have registered their interest.

If you don’t want any alerts then use None, if you only want internal alerts then either don’t specify the RefreshOptions or specify RefreshOnInternalAlert – both options will remove the alert "bell".

To ensure update of 'layers in use' on the pages listing when the referenced layers are checked-in/checked-out by other users

The RefreshOptions of the related DirectoryStyle has to be set to as:

RefreshOptions="MonitorContainer MonitorObject RefreshOnAlert"

This refreshes only the interested pages and not the entire listing.

Examples

See examples in ContainerReferences property.

See also

ContainerReferences property