Events
PDF Region Pro exposes browser events that can be bound using APEX dynamic actions.
PDF Region Pro After Save
The event uc-pdf-after-save is triggered when the Plug-in finishes processing an update via the AJAX call. Update results can be distinguished by the this.data.success property.
The event is triggered along with this.data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.success | Boolean | When it is set to true the update was successful. When it is set to false a document wasn't updated. |
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table, it is always ID. For a custom table it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
PDF Region Pro Before Save
The event uc-pdf-before-save is triggered when the end-user updates a document.
The event doesn't provide any data - this.data is set to undefined.
PDF Region Pro Document Changed
The event uc-pdf-document-changed is triggered when the end-user updates annotates on the document.
The event doesn't provide any data - this.data is set to undefined.
PDF Region Pro Document Loaded
The event uc-pdf-document-loaded is triggered every time a document is successfully loaded into PDF Region Pro.
The event is triggered along with the data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table it is always ID. For a custom table, it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL, it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
PDF Region Pro Initialized (Editor)
The event uc-pdf-editor-ready is triggered when the PDF Region Pro editor is fully loaded, note that this does not mean that the document has loaded.
The event doesn't provide any data - this.data is set to undefined.