IPXV_Plugin Interface
From PDF XChange PDF SDK
| Line 11: | Line 11: | ||
! style="text-align: left" scope="col" class="unsortable" | Description | ! style="text-align: left" scope="col" class="unsortable" | Description | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Setup|Setup]] |
| The first call by the Editor during plugin loading process | | The first call by the Editor during plugin loading process | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_RegisterExts|RegisterExts]] |
| Registers extensions provided by the plugin | | Registers extensions provided by the plugin | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_FinalizeRegistering|FinalizeRegistering]] |
| FinalizeRegistering | | FinalizeRegistering | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Init|Init]] |
| Called as on a final stage of plugins loading process | | Called as on a final stage of plugins loading process | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Unload|Unload]] |
| Called by the Editor to unload plugin | | Called by the Editor to unload plugin | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_ShowPrefsDlg|ShowPrefsDlg]] |
|Shows plugin's preferences dialog | |Shows plugin's preferences dialog | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_ImportAdditionalData|ImportAdditionalData]] |
| Imports plugins additional data during importing Editor's settings | | Imports plugins additional data during importing Editor's settings | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_ExportAdditionalData|ExportAdditionalData]] |
| Exports plugin's additional data during exporting Editor's settings | | Exports plugin's additional data during exporting Editor's settings | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_ResetSettings|ResetSettings]] |
| Resets plugin's settings during resetting Editor's settings | | Resets plugin's settings during resetting Editor's settings | ||
|} | |} | ||
| Line 49: | Line 49: | ||
! style="text-align: left" scope="col" class="unsortable" | Description | ! style="text-align: left" scope="col" class="unsortable" | Description | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Name|Name]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Localized name of the plugin | | Localized name of the plugin | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_version|version]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Plugin's version | | Plugin's version | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_CopyrightInfo|CopyrightInfo]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Developer's copyright information | | Developer's copyright information | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_VendorID|VendorID]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Developer's unique ID | | Developer's unique ID | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Description|Description]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Plugin's description | | Plugin's description | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_LegalInfo|LegalInfo]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Legal information | | Legal information | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Publisher|Publisher]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Plugin developer's name | | Plugin developer's name | ||
|- | |- | ||
| − | |[[ | + | |[[PXV:IPXV_Plugin_Features|Features]] |
| style="text-align: center" | R | | style="text-align: center" | R | ||
| Returns plugin's features flags | | Returns plugin's features flags | ||
|} | |} | ||
Revision as of 02:06, 21 March 2015
The interface of object of PDF-XChange Editor SDK.
Methods
| Method | Description |
|---|---|
| Setup | The first call by the Editor during plugin loading process |
| RegisterExts | Registers extensions provided by the plugin |
| FinalizeRegistering | FinalizeRegistering |
| Init | Called as on a final stage of plugins loading process |
| Unload | Called by the Editor to unload plugin |
| ShowPrefsDlg | Shows plugin's preferences dialog |
| ImportAdditionalData | Imports plugins additional data during importing Editor's settings |
| ExportAdditionalData | Exports plugin's additional data during exporting Editor's settings |
| ResetSettings | Resets plugin's settings during resetting Editor's settings |
Properties
All properties of IPXV_Plugin are read-only properties. Plugin provides some textual information to the user, like name, description etc. This information is mostly displayed in the list of registered plugins on Editor's preferences dialog.
| Property | Access Type | Description |
|---|---|---|
| Name | R | Localized name of the plugin |
| version | R | Plugin's version |
| CopyrightInfo | R | Developer's copyright information |
| VendorID | R | Developer's unique ID |
| Description | R | Plugin's description |
| LegalInfo | R | Legal information |
| Publisher | R | Plugin developer's name |
| Features | R | Returns plugin's features flags |
