Document Methods |
The Document type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | applyBookmark | Applies a bookmark by its name. The Application.onError
event will be fired if the bookmark does not exist. |
| applyBookmarkById | Applies a bookmark by its id. The Application.onError
event will be fired if the bookmark does not exist. |
| close | Close the document. The Application.onClosed
event will be raised for the document. Note that there may be other open document instances for the application. |
| downloadAsDxp |
Download the analysis as a dxp file.
|
| executeCustomExportTool |
Execute a custom export tool.
|
| executeCustomTool |
Execute a custom tool.
|
| exportActiveVisualAsImage |
Export the active visual as image. The image will be opened in a new browser tab or window.
|
| exportReport | Exports the report, specified by name, to PDF. |
| exportToPdf |
Launch the export to Pdf wizard.
|
| exportToPowerPoint |
Launch the export to PowerPoint wizard.
|
| getActivePage | Get the information about the active page. |
| getBookmarkNames | Get the names of the bookmarks in the document. |
| getBookmarks | Get the ids of the bookmarks in the document. |
| getDocumentMetadata | Get the metadata for the document. |
| getDocumentProperties | Get a list of all the properties in the document. |
| getDocumentProperty | Get the information about the property with given name. |
| getDocumentState | Get the current document state. |
| getPages | Get a list of the pages in the current document. |
| getReports | Get the names of the reports in the analysis. |
| logout |
Logout the user.
|
| onActivePageChanged | Event raised when the active page changes in the analysis. |
| onDocumentMetadataChanged |
Register a callback function that will be called when the metadata for the document changes.
|
| onDocumentPropertyChanged | Event raised when the given property has changed value. |
| onDocumentReady | Event raised, when the document switches to the ready state (the
round icon in the status bar becomes green). |
| onDocumentStateChanged |
Register a callback function that will be called when the document state changes.
|
|
Launch the print wizard.
| |
| setActivePage(Int32) | Change the active page. The Application.onError
event will be fired if index does not exist. |
| setActivePage(String) | Change the active page. The Application.onError
event will be fired if page title does not exist. |
| setDocumentProperty | Set the value of an existing property. |
See Also