AutoRefreshMenu.setPeriodicalRefresh

Syntax

setPeriodicalRefresh(value: Boolean);

Parameters

value. The parameter determines whether to enable (True) or disable (False) periodic refresh.

Description

The setPeriodicalRefresh method enables or disables periodic refresh.

Example

To execute the example, the HTML page must contain the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Enable periodic refresh of report:

// Get report autoupdate menu by steps
ribbonView = expressBox.getRibbonView();
control = ribbonView.getControl();
auReMenuControl = control.getControlById("MainAutoRefreshButton");
autoRefreshMenu = auReMenuControl.getMenu();
// Start periodic refresh of report
autoRefreshMenu.setPeriodicalRefresh(true);

After executing the example periodic refresh of report is set up.