WbkCategoryView.getRefreshButton

Syntax

getRefreshButton();

Description

The getRefreshButton method returns the Refresh button in the workbook ribbon.

Comments

This method returns value of the PP.Ui.RibbonButton.

Example

To execute the example, the HTML page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component). Increase width of the Refresh button and refresh the Home tab that houses this button:

// Get tool ribbon
var ribbon = workbookBox.getRibbonView();
// Get the Home tool ribbon category
var mainCategory = ribbon.getMainCategory();
// Get the Refresh button
var refreshButton = mainCategory.getRefreshButton();
// Expand this button
refreshButton.setWidth(120);
// Refresh the Home tool ribbon tab
mainCategory.refreshAll();

After executing the example width of the Refresh button is increased to 120 pixels: