PrxDocument.MetadataChanged

Syntax

MetadataChanged: PP.Delegate | function (sender, args)

Parameters

sender. Event source.

args. Information on the event. Arguments are the following elements of the PP.Prx.Property enumeration:

Recalc. Full report update (default).
ControlValue. Update control values.
DimSelection. Update dimensions selection.
ActiveSheet. Update active sheet.

Description

The MetadataChanged event is fired on changing metadata of report text sheet.

Comments

The event occurs on calling the PrxDocument.refresh method.

Example

To execute this example, the page must contain the ReportBox component named reportBox (see Example of the ReportBox Component Layout). The open regular report must include a text sheet. Refresh active text sheet:

dv = reportBox.getDataView(); //get report data area

doc = dv.getActiveSheetView(); //get active sheet (text sheet)

doc.MetadataChanged.add(function (sender, args) {

console.log(args)

});

doc.refresh(PP.Prx.Property.ActiveSheet);

After executing the example active text sheet in the report is refreshed, and the browser console shows the message ActiveSheet.