Exclusive API for Email Button

11.0

Added the changeFormat API.

API

changeFormat(items)

To modify the format options supported in the email button.

Parameter

items：newFormats[]

The formats supported after modification, which are provided in a string array.

Returned Value

void

Example

Example 1: You can modify the format supported in the email button to PDF when the obtained toolbar email button object is defined as button.

button.changeFormat(['pdf']);

Example 2: In a general report, you can modify the format supported in the email button to PDF only.

_g().getToolbar().getWidgetByName("email").changeFormat(['pdf']);

Example 3: In a general report, you can modify the formats supported in the email button to PDF and Word.

_g().getToolbar().getWidgetByName("email").changeFormat(['pdf','Word']);

Application Example

Example 4:  You can modify the format supported in the email button to PDF only.

For details, you can download the template Modifying Format for Email Button.cpt.

Mobile Terminal

This API is not supported on mobile terminals.