IPXV_Plugin Interface

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
  
 
== Methods ==
 
== Methods ==
 
 
{| class="wikitable sortable collapsible" style="width: 100%"
 
{| class="wikitable sortable collapsible" style="width: 100%"
 
|-
 
|-
Line 11: Line 10:
 
! style="text-align: left" scope="col" class="unsortable" | Description
 
! style="text-align: left" scope="col" class="unsortable" | Description
 
|-
 
|-
|[[PXV:IPXV_Plugin_Setup|Setup]]
+
| [[PXV:IPXV_Plugin_ExportAdditionalData|ExportAdditionalData]]
| The first call by the Editor during plugin loading process
+
| Exports plugin's additional data during exporting Editor's settings.
 
|-
 
|-
|[[PXV:IPXV_Plugin_RegisterExts|RegisterExts]]
+
| [[PXV:IPXV_Plugin_FinalizeRegistering|FinalizeRegistering]]
| Registers extensions provided by the plugin
+
| Finalize Registering.
 
|-
 
|-
|[[PXV:IPXV_Plugin_FinalizeRegistering|FinalizeRegistering]]
+
| [[PXV:IPXV_Plugin_ImportAdditionalData|ImportAdditionalData]]
| FinalizeRegistering
+
| Imports plugins additional data during importing Editor's settings.
 
|-
 
|-
|[[PXV:IPXV_Plugin_Init|Init]]
+
| [[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]]
+
| [[PXV:IPXV_Plugin_RegisterExts|RegisterExts]]
| Called by the Editor to unload plugin
+
| Registers extensions provided by the plugin.
 
|-
 
|-
|[[PXV:IPXV_Plugin_ShowPrefsDlg|ShowPrefsDlg]]
+
| [[PXV:IPXV_Plugin_ResetSettings|ResetSettings]]
|Shows plugin's preferences dialog
+
| Resets plugin's settings during resetting Editor's settings.
 
|-
 
|-
|[[PXV:IPXV_Plugin_ImportAdditionalData|ImportAdditionalData]]
+
| [[PXV:IPXV_Plugin_Setup|Setup]]
| Imports plugins additional data during importing Editor's settings
+
| The first call by the Editor during plugin loading process.
 
|-
 
|-
|[[PXV:IPXV_Plugin_ExportAdditionalData|ExportAdditionalData]]
+
| [[PXV:IPXV_Plugin_ShowPrefsDlg|ShowPrefsDlg]]
| Exports plugin's additional data during exporting Editor's settings
+
| Shows plugin's preferences dialog.
 
|-
 
|-
|[[PXV:IPXV_Plugin_ResetSettings|ResetSettings]]
+
| [[PXV:IPXV_Plugin_Unload|Unload]]
| Resets plugin's settings during resetting Editor's settings
+
| Called by the Editor to unload plugin.
 
|}
 
|}
  
 
== Properties ==
 
== Properties ==
All properties of IPXV_Plugin are read-only 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.
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.
+
  
 
{| style="width: 100%" class="wikitable sortable collapsible"
 
{| style="width: 100%" class="wikitable sortable collapsible"
Line 49: Line 47:
 
! style="text-align: left" scope="col"  class="unsortable" | Description
 
! style="text-align: left" scope="col"  class="unsortable" | Description
 
|-
 
|-
|[[PXV:IPXV_Plugin_Name|Name]]  
+
| [[PXV:IPXV_Plugin__GUID|_GUID]]
 +
| style="text-align: center" | R
 +
| Plugin's unique ID.
 +
|-
 +
| [[PXV:IPXV_Plugin_CopyrightInfo|CopyrightInfo]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Localized name of the plugin
+
| Developer's copyright information.
 
|-
 
|-
|[[PXV:IPXV_Plugin_version|version]]  
+
| [[PXV:IPXV_Plugin_Description|Description]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Plugin's version
+
| Plugin's description.
 
|-
 
|-
|[[PXV:IPXV_Plugin_CopyrightInfo|CopyrightInfo]]  
+
| [[PXV:IPXV_Plugin_Features|Features]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Developer's copyright information
+
| Returns plugin's features flags.
 
|-
 
|-
|[[PXV:IPXV_Plugin_VendorID|VendorID]]  
+
| [[PXV:IPXV_Plugin_LegalInfo|LegalInfo]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Developer's unique ID
+
| Legal information.
 
|-
 
|-
|[[PXV:IPXV_Plugin_Description|Description]]  
+
| [[PXV:IPXV_Plugin_Name|Name]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Plugin's description
+
| Localized name of the plugin.
 
|-
 
|-
|[[PXV:IPXV_Plugin_LegalInfo|LegalInfo]]  
+
| [[PXV:IPXV_Plugin_Publisher|Publisher]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Legal information
+
| Plugin developer's name.
 
|-
 
|-
|[[PXV:IPXV_Plugin_Publisher|Publisher]]  
+
| [[PXV:IPXV_Plugin_VendorID|VendorID]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Plugin developer's name
+
| Developer's unique ID.
 
|-
 
|-
|[[PXV:IPXV_Plugin_Features|Features]]  
+
| [[PXV:IPXV_Plugin_version|version]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
| Returns plugin's features flags
+
| Plugin's version.
 
|}
 
|}

Revision as of 02:13, 21 March 2015

The interface of object of PDF-XChange Editor SDK.

Methods

Method Description
ExportAdditionalData Exports plugin's additional data during exporting Editor's settings.
FinalizeRegistering Finalize Registering.
ImportAdditionalData Imports plugins additional data during importing Editor's settings.
Init Called as on a final stage of plugins loading process.
RegisterExts Registers extensions provided by the plugin.
ResetSettings Resets plugin's settings during resetting Editor's settings.
Setup The first call by the Editor during plugin loading process.
ShowPrefsDlg Shows plugin's preferences dialog.
Unload Called by the Editor to unload plugin.

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
_GUID R Plugin's unique ID.
CopyrightInfo R Developer's copyright information.
Description R Plugin's description.
Features R Returns plugin's features flags.
LegalInfo R Legal information.
Name R Localized name of the plugin.
Publisher R Plugin developer's name.
VendorID R Developer's unique ID.
version R Plugin's version.