TitleBox.refresh

Syntax

refresh(args: PP.Mb.Ui.PropertyChangedEventArgs);

Parameters

args. Parameters presented as an object of the PP.Mb.Ui.PropertyChangedEventArgs class. Optional parameter.

Description

The refresh method refreshes the express report title.

Comments

The method returns True if the title was successfully updated, otherwise the method returns False.

Example

Executing the example requires that the HTML page contains the TitleBox component named titleBox (see Example of Creating the EaxTitleMaster Component). Refresh the title:

// Handle the Refreshed event
title.Refreshed.add(function (sender, args) {
    console.log(args.AllUpdate ? "Title is fully refreshed" : "Title is not fully refreshed");
    // Get title settings
    var options = title.getOptions();
    console.log(options.visible ? "Title is shown" : "Title is hidden" );
});
// Refresh title
title.refresh();

After executing the example the title is refreshed. After the Refreshed event occurs, the browser console displays messages that the title is visible and completely refreshed.