IPXV_Plugin Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Plugin Interface}}
 
{{#customTitle:IPXV_Plugin Interface}}
 +
{{#parentPage:PXV:PXV_Interfaces|IPXV_Plugin|interface}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The interface of object of PDF-XChange Editor SDK.
 
The interface of object of PDF-XChange Editor SDK.
 +
 +
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.
  
 
== Methods ==
 
== Methods ==
−
 
+
{| class="wikitable methods"
−
{| class="wikitable sortable collapsible" style="width: 100%"
+
 
|-
 
|-
−
! style="text-align: left" scope="col" width="15%" | Method
+
| [[PXV:IPXV_Plugin_ExportAdditionalData|ExportAdditionalData]]
−
! style="text-align: left" scope="col" class="unsortable" | Description
+
| [[PXV:IPXV_Plugin_Init|Init]]
 +
| [[PXV:IPXV_Plugin_ResetSettings|ResetSettings]]
 +
| [[PXV:IPXV_Plugin_ShowPrefsDlg|ShowPrefsDlg]]
 
|-
 
|-
−
|[[PXV:IPXV_Plugin_Setup|Setup]]
+
| [[PXV:IPXV_Plugin_FinalizeRegistering|FinalizeRegistering]]
−
| The first call by the Editor during plugin loading process
+
| [[PXV:IPXV_Plugin_RegisterExts|RegisterExts]]
 +
| [[PXV:IPXV_Plugin_Setup|Setup]]
 +
| [[PXV:IPXV_Plugin_Unload|Unload]]
 
|-
 
|-
−
|[[PXV:IPXV_Plugin_RegisterExts|RegisterExts]]
+
| [[PXV:IPXV_Plugin_ImportAdditionalData|ImportAdditionalData]]
−
| Registers extensions provided by the plugin
+
|  
−
|-
+
|  
−
|[[PXV:IPXV_Plugin_FinalizeRegistering|FinalizeRegistering]]
+
|  
−
| FinalizeRegistering
+
−
|-
+
−
|[[PXV:IPXV_Plugin_Init|Init]]
+
−
| Called as on a final stage of plugins loading process
+
−
|-
+
−
|[[PXV:IPXV_Plugin_Unload|Unload]]
+
−
| Called by the Editor to unload plugin
+
−
|-
+
−
|[[PXV:IPXV_Plugin_ShowPrefsDlg|ShowPrefsDlg]]
+
−
|Shows plugin's preferences dialog
+
−
|-
+
−
|[[PXV:IPXV_Plugin_ImportAdditionalData|ImportAdditionalData]]
+
−
| Imports plugins additional data during importing Editor's settings
+
−
|-
+
−
|[[PXV:IPXV_Plugin_ExportAdditionalData|ExportAdditionalData]]
+
−
| Exports plugin's additional data during exporting Editor's settings
+
−
|-
+
−
|[[PXV:IPXV_Plugin_ResetSettings|ResetSettings]]
+
−
| Resets plugin's settings during resetting Editor's settings
+
 
|}
 
|}
  
 
== Properties ==
 
== Properties ==
−
All properties of IPXV_Plugin are read-only properties.
+
{| class="wikitable 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.
+
−
 
+
−
{| style="width: 100%" class="wikitable sortable collapsible"
+
 
|-
 
|-
−
! style="text-align: left" scope="col" width="15%" | Property
+
| [[PXV:IPXV_Plugin__GUID|_GUID]]
−
! style="text-align: center" scope="col" width="5%" | Access Type
+
| [[PXV:IPXV_Plugin_Features|Features]]
−
! style="text-align: left" scope="col"  class="unsortable" | Description
+
| [[PXV:IPXV_Plugin_Name|Name]]
 +
| [[PXV:IPXV_Plugin_VendorID|VendorID]]
 
|-
 
|-
−
|[[PXV:IPXV_Plugin_Name|Name]]  
+
| [[PXV:IPXV_Plugin_CopyrightInfo|CopyrightInfo]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Plugin_LegalInfo|LegalInfo]]
−
| Localized name of the plugin
+
| [[PXV:IPXV_Plugin_Publisher|Publisher]]
 +
| [[PXV:IPXV_Plugin_version|version]]
 
|-
 
|-
−
|[[PXV:IPXV_Plugin_version|version]]
+
| [[PXV:IPXV_Plugin_Description|Description]]
−
| style="text-align: center" | R
+
|  
−
| Plugin's version
+
|  
−
|-
+
|  
−
|[[PXV:IPXV_Plugin_CopyrightInfo|CopyrightInfo]]
+
−
| style="text-align: center" | R
+
−
| Developer's copyright information
+
−
|-
+
−
|[[PXV:IPXV_Plugin_VendorID|VendorID]]
+
−
| style="text-align: center" | R
+
−
| Developer's unique ID
+
−
|-
+
−
|[[PXV:IPXV_Plugin_Description|Description]]  
+
−
| style="text-align: center" | R
+
−
| Plugin's description
+
−
|-
+
−
|[[PXV:IPXV_Plugin_LegalInfo|LegalInfo]]
+
−
| style="text-align: center" | R
+
−
| Legal information
+
−
|-
+
−
|[[PXV:IPXV_Plugin_Publisher|Publisher]]
+
−
| style="text-align: center" | R
+
−
| Plugin developer's name
+
−
|-
+
−
|[[PXV:IPXV_Plugin_Features|Features]]
+
−
| style="text-align: center" | R
+
−
| Returns plugin's features flags
+
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IPXV_Inst_AddPlugin|IPXV_Inst::AddPlugin]], [[PXV:IPXV_Inst_GetPluginSettings|IPXV_Inst::GetPluginSettings]]

Latest revision as of 09:31, 23 May 2015

PDF Editor Layer > Interfaces > IPXV_Plugin Interface


The interface of object of PDF-XChange Editor SDK.

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.

Methods

ExportAdditionalData Init ResetSettings ShowPrefsDlg
FinalizeRegistering RegisterExts Setup Unload
ImportAdditionalData

Properties

_GUID Features Name VendorID
CopyrightInfo LegalInfo Publisher version
Description

See Also

IPXV_Inst::AddPlugin, IPXV_Inst::GetPluginSettings

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXV_Plugin&oldid=36312"