Toolbar API

11.0

Difference from 10.0:

• Changed the button aquisition API parameter. In the 11.0 version, the button name is used.

• Added toolBarFloat and setStyle APIs.

• Added the getToolbar API.

name: string

Button name, which is a string. The following lists common button names.

• submit: submission button

• verify: data validation

• first: homepage

• previous: previous page

• next: next page

• last: last page

• newprint: printing

• flashprint: printing (client)

• email: email

• export: export

Note:

The export button is supported only in 11.0.27 and later versions.

• PDF: PDF

• pagenavi: current page/total number of pages

• stashbutton: temporary storage

• clear: clearance

Button object

object

Example 1: If the obtained toolbar object is defined as toolbar, get the email button on the toolbar using the following command.

toolbar.getWidgetByName("email");

Example 2: Get the email button on the   toolbar in a general report using the following command.

_g().getToolbar().getWidgetByName("email");

After successful submission, the Email and Print buttons are hidden on the toolbar.

Click to download the template: Invisible Toolbar Button.cpt.

This API is not supported on mobile terminals.

/

/

Button object

object

Example 1: If the obtained report object is defined as report, get the toolbar object using the following command.

report.getToolbar();

Example 2: Get the toolbar object in a general report using the following command.

_g().getToolbar();

/

This API is supported on mobile terminals.

index: number

Toolbar position, which is a number.

• 0: top toolbar

• 1: bottom toolbar

Toolbar object

object

Example 1: If the obtained report block object is defined as report, get the toolbar object using the following command.

report.getToolbar(0);

Example 2: Get the top toolbar object of the report0 block in a dashboard using the following command.

_g().getWidgetByName("report0").getToolbar(0);

Example 3: Get and hide the top toolbar of the report0 block in a dashboard using the following command.

_g().getWidgetByName("report0").getToolbar(0).setVisible(false);

Click the button to hide the report block toolbar in a dashboard.

Click to download the template: Hiding the Report Block Toolbar.frm. 

This API is supported on mobile terminals.

direction: string

Display method, which is a string.

• left: left alignment

• right: right alignment

• center: center alignment

void

Example 1: If the obtained toolbar object is defined as toolbar, center the toolbar using the following command.

toolbar.toolBarFloat('center');

Example 2: Center the toolbar in a general report using the following command.

_g().getToolbar().toolBarFloat('center');

Example 3: Center the toolbar in a dashboard using the following command.

_g().getWidgetByName('report0').getToolbar(0).toolBarFloat('center');

Center the toolbar in a general report.

Click to download the template: Centered Toolbar.cpt.

This API is not supported on mobile terminals.

style:

{

width: number,

height: number

}

Toolbar size, which is in JSON format.

• width: toolbar length

• height: toolbar height

void

Example 1: If the obtained toolbar object is defined as toolbar, resize the toolbar to 900 in lenght and 60 in height using the following command.

toolbar.setStyle({    width: 900,    height: 60});

Example 2: Resize the toolbar to 900 in lenght and 60 in height in a general report using the following command.

_g().getToolbar().setStyle({    width: 900,    height: 60});

Example 3: Resize the toolbar to 900 in lenght and 60 in height in a dashboard using the following command.

_g().getWidgetByName('report0').getToolbar(0).setStyle({    width: 900,    height: 60});

Resize the toolbar to 900 in lenght and 60 in height in a general report.

Click to download the template: Toolbar Resizing.cpt.

This API is not supported on mobile terminals.

visibility: boolean

Whether to show the toolbar (boolean type).

• true: toolbar display

• false: toolbar hidden

void

Example 1: If the obtained toolbar object is defined as toolbar, hide   the toolbar using the following command.

toolbar.setVisible(false);

Example 2: Hide the toolbar in a general report using the following command.

_g().getToolbar().setVisible(false);

Example 3: Hide the toolbar in a dashboard using the following command.

_g().getWidgetByName('report0').getToolbar(0).setVisible(false);

Hide the toolbar in a general report.

Click to download the template: Toolbar Hiding.cpt.

This API is supported on mobile terminals.