AutoRefreshMenu.setRefresh

Syntax

setRefresh(markChanged: Boolean, periodical: Boolean);

Parameters

markChanged. The parameter determines whether to enable (True) or disable (False) autoupdate on selection change

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

Description

The setRefresh method enables or disables autoupdate on selection change and periodic refresh.

Example

To execute the example, the HTML page must contain the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Disable autoupdate on selection change, enable periodic refresh of report:

// Get report autoupdate menu by steps
ribbonView = expressBox.getRibbonView();
control = ribbonView.getControl();
auReMenuControl = control.getControlById("MainAutoRefreshButton");
autoRefreshMenu = auReMenuControl.getMenu();
// Disable autoupdate on selection change, start periodic refresh of report
autoRefreshMenu.setRefresh(false, true);

After executing the example autoupdate on selection change is disabled and periodic refresh of report is enabled.