WbkCategoryView.RequestMetadata

Syntax

RequestMetadata: function(sender, args);

Parameters

sender. Event source.

args. Event information.

Description

The RequestMetadata event is fired when no data is available in workbook ribbon data source.

Example

To execute the example, the HTML page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component). Process and fire the RequestMetadata event, so that the browser console displays a notice of the current metadata request on firing the event:

// Get tool ribbon
var ribbon = workbookBox.getRibbonView();
// Get the Home tool ribbon category
var mainCategory = ribbon.getMainCategory();
// Process the RequestMetadata event
mainCategory.RequestMetadata.add(function (sender, args) {
    console.log("Request metadata...");
});
// Fire this event
mainCategory.RequestMetadata.fire(this);

After executing the example each time the RequestMetadata event is fired, the browser console displays a notice that metadata request is performed:

Request metadata...