IPXV_Inst Interface

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXV_Inst Interface}}
 
{{#customTitle:IPXV_Inst Interface}}
  
−
The interface of object of PDF-XChange Editor SDK.
+
The interface of general object of PDF-XChange Editor SDK. Inherits from the '''IDispatch''' interface.
  
 
== Methods ==
 
== Methods ==
Line 11: Line 11:
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AddDefaultTranslationData|AddDefaultTranslationData]]
 
| [[PXV:IPXV_Inst_AddDefaultTranslationData|AddDefaultTranslationData]]
−
| ...
+
| Adds special xml with default(built-in) strings for UI-localization. Each module(plug-in) can add its own default strings inside his <code>IPXV_Plugin::FinalizeRegistering()</code> procedure.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AddPlugin|AddPlugin]]
 
| [[PXV:IPXV_Inst_AddPlugin|AddPlugin]]
−
| ...
+
| Adds a plugin object to the instance.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AddPluginFromFile|AddPluginFromFile]]
 
| [[PXV:IPXV_Inst_AddPluginFromFile|AddPluginFromFile]]
−
| ...
+
| Adds a plugin to the instance from specified file.&nbsp; Function can be called only in plugins loading mode.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AsyncDo|AsyncDo]]
 
| [[PXV:IPXV_Inst_AsyncDo|AsyncDo]]
−
| ...
+
| Runs the specified operation in background thread.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AsyncDoAndWaitForFinish|AsyncDoAndWaitForFinish]]
 
| [[PXV:IPXV_Inst_AsyncDoAndWaitForFinish|AsyncDoAndWaitForFinish]]
−
| ...
+
| Run operation in background thread and wait (with non-blocking UI) for finish.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ClearHistory|ClearHistory]]
 
| [[PXV:IPXV_Inst_ClearHistory|ClearHistory]]
−
| ...
+
| Removes documents opening history entirely.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateAnnotsList|CreateAnnotsList]]
 
| [[PXV:IPXV_Inst_CreateAnnotsList|CreateAnnotsList]]
−
| ...
+
| Creates new container: annotations list.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateBookmList|CreateBookmList]]
 
| [[PXV:IPXV_Inst_CreateBookmList|CreateBookmList]]
−
| ...
+
| Creates new container: bookmarks list.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateMeasureUnitsConvTbl|CreateMeasureUnitsConvTbl]]
 
| [[PXV:IPXV_Inst_CreateMeasureUnitsConvTbl|CreateMeasureUnitsConvTbl]]
−
| ...
+
| Creates an special conversion-table to translate on-fly the entered by user value from other units to current unit.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateNewMainFrm|CreateNewMainFrm]]
 
| [[PXV:IPXV_Inst_CreateNewMainFrm|CreateNewMainFrm]]
−
| ...
+
| Creates new main frame window.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateOp|CreateOp]]
 
| [[PXV:IPXV_Inst_CreateOp|CreateOp]]
−
| ...
+
| Creates new operation-object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateOpenDocParams|CreateOpenDocParams]]
 
| [[PXV:IPXV_Inst_CreateOpenDocParams|CreateOpenDocParams]]
−
| ...
+
| Creates structured container of parameters that might be used for opening documents.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreatePageSizeCtl|CreatePageSizeCtl]]
 
| [[PXV:IPXV_Inst_CreatePageSizeCtl|CreatePageSizeCtl]]
−
| ...
+
| Creates UI-control to show/change the page size..
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreatePageSizeHelper|CreatePageSizeHelper]]
 
| [[PXV:IPXV_Inst_CreatePageSizeHelper|CreatePageSizeHelper]]
Line 53: Line 53:
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateStdPresetsButton|CreateStdPresetsButton]]
 
| [[PXV:IPXV_Inst_CreateStdPresetsButton|CreateStdPresetsButton]]
−
| ...
+
| Creates new presets button to provide to user the simple access to presets list.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateStdPresetsCallbacks|CreateStdPresetsCallbacks]]
 
| [[PXV:IPXV_Inst_CreateStdPresetsCallbacks|CreateStdPresetsCallbacks]]
−
| ...
+
| Creates new standard presets management helper.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateStdRangeCtl|CreateStdRangeCtl]]
 
| [[PXV:IPXV_Inst_CreateStdRangeCtl|CreateStdRangeCtl]]
−
| ...
+
| Creates special UI-control to show/change the pages range.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ExecUICmd|ExecUICmd]]
 
| [[PXV:IPXV_Inst_ExecUICmd|ExecUICmd]]
−
| ...
+
| Runs the UI-command specified by unigue name.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ExecUICmd2|ExecUICmd2]]
 
| [[PXV:IPXV_Inst_ExecUICmd2|ExecUICmd2]]
−
| ...
+
| Runs the UI-command specified by unigue identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ExecuteJS|ExecuteJS]]
 
| [[PXV:IPXV_Inst_ExecuteJS|ExecuteJS]]
−
| ...
+
| Executes the specified Java Script.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FindDocByCoreDoc|FindDocByCoreDoc]]
 
| [[PXV:IPXV_Inst_FindDocByCoreDoc|FindDocByCoreDoc]]
−
| ...
+
| Finds opened document by pointer to core-document object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FindDocByID|FindDocByID]]
 
| [[PXV:IPXV_Inst_FindDocByID|FindDocByID]]
−
| ...
+
| Finds opened document by unique identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FindDocBySrcFile|FindDocBySrcFile]]
 
| [[PXV:IPXV_Inst_FindDocBySrcFile|FindDocBySrcFile]]
−
| ...
+
| Finds opened document by pointer to source file object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FindDocBySrcFileName|FindDocBySrcFileName]]
 
| [[PXV:IPXV_Inst_FindDocBySrcFileName|FindDocBySrcFileName]]
−
| ...
+
| Finds opened document by pointer source file name object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FindDocBySrcFileName2|FindDocBySrcFileName2]]
 
| [[PXV:IPXV_Inst_FindDocBySrcFileName2|FindDocBySrcFileName2]]
−
| ...
+
| Finds opened document by source file name.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FinishLoadingPlugins|FinishLoadingPlugins]]
 
| [[PXV:IPXV_Inst_FinishLoadingPlugins|FinishLoadingPlugins]]
−
| ...
+
| Finish a loading plugins mode for the instance. This method can be called only once.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged|FireAppPrefsChanged]]
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged|FireAppPrefsChanged]]
−
| ...
+
| Notifies all listeners about changes of preferences in specified category.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged2|FireAppPrefsChanged2]]
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged2|FireAppPrefsChanged2]]
−
| ...
+
| Notifies all listeners about complex changes of preferences.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FireCmdCustomizationEvent|FireCmdCustomizationEvent]]
 
| [[PXV:IPXV_Inst_FireCmdCustomizationEvent|FireCmdCustomizationEvent]]
−
| ...
+
| Notifies all listeners about new customization of toolbars/menus.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FormatFileSize|FormatFileSize]]
 
| [[PXV:IPXV_Inst_FormatFileSize|FormatFileSize]]
−
| ...
+
| Formats file size as text for display.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FormatMeasureValue|FormatMeasureValue]]
 
| [[PXV:IPXV_Inst_FormatMeasureValue|FormatMeasureValue]]
−
| ...
+
| Formats measurement value.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_FormatNumber|FormatNumber]]
 
| [[PXV:IPXV_Inst_FormatNumber|FormatNumber]]
Line 110: Line 110:
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetAnnotHandler|GetAnnotHandler]]
 
| [[PXV:IPXV_Inst_GetAnnotHandler|GetAnnotHandler]]
−
| ...
+
| Gets handler for PDF-annotation.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetDlgParentWindow|GetDlgParentWindow]]
 
| [[PXV:IPXV_Inst_GetDlgParentWindow|GetDlgParentWindow]]
−
| ...
+
| Gets handle of right parent window for dialog that will be displayed for specified document.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetDocSelectionHandler|GetDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_GetDocSelectionHandler|GetDocSelectionHandler]]
−
| ...
+
| Gets document selection handler by specified document and selection-object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetExtension|GetExtension]]
 
| [[PXV:IPXV_Inst_GetExtension|GetExtension]]
−
| ...
+
| Gets an extension by its unique name.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetHandlerForAction|GetHandlerForAction]]
 
| [[PXV:IPXV_Inst_GetHandlerForAction|GetHandlerForAction]]
−
| ...
+
| Gets the PDF-action handler by action type identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetLocalNameForSave|GetLocalNameForSave]]
 
| [[PXV:IPXV_Inst_GetLocalNameForSave|GetLocalNameForSave]]
−
| ...
+
| Shows '''Save File''' dialog and gets destination file name that is specified by user.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetLocalNamesForOpen|GetLocalNamesForOpen]]
 
| [[PXV:IPXV_Inst_GetLocalNamesForOpen|GetLocalNamesForOpen]]
−
| ...
+
| Shows '''Open File''' dialog and gets the file(s) chosed by user to open.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetLocalPathName|GetLocalPathName]]
 
| [[PXV:IPXV_Inst_GetLocalPathName|GetLocalPathName]]
−
| ...
+
| Show '''Select Folder''' dialog and gets destination folder path that is specified by user.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetLocalStr|GetLocalStr]]
 
| [[PXV:IPXV_Inst_GetLocalStr|GetLocalStr]]
−
| ...
+
| Gets localized string by specified unique string indentifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetLocalStr2|GetLocalStr2]]
 
| [[PXV:IPXV_Inst_GetLocalStr2|GetLocalStr2]]
−
| ...
+
| Gets localized string by specified unique numerical indentifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetMeasureUnitInfo|GetMeasureUnitInfo]]
 
| [[PXV:IPXV_Inst_GetMeasureUnitInfo|GetMeasureUnitInfo]]
−
| ...
+
| Gets special info about specified unit of measurement.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetPathToHistory|GetPathToHistory]]
 
| [[PXV:IPXV_Inst_GetPathToHistory|GetPathToHistory]]
−
| ...
+
| Gets path to source of document opening history.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetPathToUserSettings|GetPathToUserSettings]]
 
| [[PXV:IPXV_Inst_GetPathToUserSettings|GetPathToUserSettings]]
−
| ...
+
| Gets path to source of user's preferences.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetPluginSettings|GetPluginSettings]]
 
| [[PXV:IPXV_Inst_GetPluginSettings|GetPluginSettings]]
−
| ...
+
| Gets reference to node in application's options-storage that contains all settings of specified plugin.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetPrinters|GetPrinters]]
 
| [[PXV:IPXV_Inst_GetPrinters|GetPrinters]]
−
| ...
+
| Gets names list of all installed printers.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetStdFolder|GetStdFolder]]
 
| [[PXV:IPXV_Inst_GetStdFolder|GetStdFolder]]
−
| ...
+
| Gets full path to special program folder.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetTextFromHRes|GetTextFromHRes]]
 
| [[PXV:IPXV_Inst_GetTextFromHRes|GetTextFromHRes]]
−
| ...
+
| Gets user friendly decription text of error- of warning- code value(HRESULT).
 
|-
 
|-
 
| [[PXV:IPXV_Inst_GetTool|GetTool]]
 
| [[PXV:IPXV_Inst_GetTool|GetTool]]
−
| ...
+
| Gets the tool object by specified identifier of tool.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ID2Str|ID2Str]]
 
| [[PXV:IPXV_Inst_ID2Str|ID2Str]]
−
| ...
+
| Converts numerical identifier that was previously obtained by Str2ID&nbsp; to corresponding string identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_Init|Init]]
 
| [[PXV:IPXV_Inst_Init|Init]]
−
| ...
+
| Initializes the main instance object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_IsCmdBarVisible|IsCmdBarVisible]]
 
| [[PXV:IPXV_Inst_IsCmdBarVisible|IsCmdBarVisible]]
−
| ...
+
| Gets visibility state of toolbar.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_IsCmdBarVisible2|IsCmdBarVisible2]]
 
| [[PXV:IPXV_Inst_IsCmdBarVisible2|IsCmdBarVisible2]]
−
| ...
+
| Gets visibility state of toolbar.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ModifyCoreDoc|ModifyCoreDoc]]
 
| [[PXV:IPXV_Inst_ModifyCoreDoc|ModifyCoreDoc]]
−
| ...
+
| Changes '''modified''' state of the core-document.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ModifyDoc|ModifyDoc]]
 
| [[PXV:IPXV_Inst_ModifyDoc|ModifyDoc]]
−
| ...
+
| Changes '''modified''' state of the opened document.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_NewCoreDoc|NewCoreDoc]]
 
| [[PXV:IPXV_Inst_NewCoreDoc|NewCoreDoc]]
Line 185: Line 185:
 
|-
 
|-
 
| [[PXV:IPXV_Inst_PerformActions|PerformActions]]
 
| [[PXV:IPXV_Inst_PerformActions|PerformActions]]
−
| ...
+
| Executes the PDF-action.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterActionHandler|RegisterActionHandler]]
 
| [[PXV:IPXV_Inst_RegisterActionHandler|RegisterActionHandler]]
−
| ...
+
| Registers new PDF-action handler.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterDocSelectionHandler|RegisterDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_RegisterDocSelectionHandler|RegisterDocSelectionHandler]]
−
| ...
+
| Registers new document selection handler.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterExportConverter|RegisterExportConverter]]
 
| [[PXV:IPXV_Inst_RegisterExportConverter|RegisterExportConverter]]
−
| ...
+
| Registers new export-PDF-to-other converter.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterExtension|RegisterExtension]]
 
| [[PXV:IPXV_Inst_RegisterExtension|RegisterExtension]]
−
| ...
+
| Registers a custom extension.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterImportConverter|RegisterImportConverter]]
 
| [[PXV:IPXV_Inst_RegisterImportConverter|RegisterImportConverter]]
−
| ...
+
| Registers new import-something -to-PDF converter.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterOpCreator|RegisterOpCreator]]
 
| [[PXV:IPXV_Inst_RegisterOpCreator|RegisterOpCreator]]
−
| ...
+
| Registers new creator for operations.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterTool|RegisterTool]]
 
| [[PXV:IPXV_Inst_RegisterTool|RegisterTool]]
−
| ...
+
| Registers new tool-object that extends interaction level for pages view.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RegisterViewCreator|RegisterViewCreator]]
 
| [[PXV:IPXV_Inst_RegisterViewCreator|RegisterViewCreator]]
−
| ...
+
| Registers new creator of common UI-objects that implements '''IPXV_View''' interface.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ResetCmdCustomization|ResetCmdCustomization]]
 
| [[PXV:IPXV_Inst_ResetCmdCustomization|ResetCmdCustomization]]
−
| ...
+
| Removes toolbars customization.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_RestartTimer|RestartTimer]]
 
| [[PXV:IPXV_Inst_RestartTimer|RestartTimer]]
−
| ...
+
| Restarts the custom timer.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SaveHistory|SaveHistory]]
 
| [[PXV:IPXV_Inst_SaveHistory|SaveHistory]]
−
| ...
+
| Saves documents opening history to specified storage.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SaveUserSettings|SaveUserSettings]]
 
| [[PXV:IPXV_Inst_SaveUserSettings|SaveUserSettings]]
−
| ...
+
| Save all user's preferences to specified storage.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SetReservedLowMemory|SetReservedLowMemory]]
 
| [[PXV:IPXV_Inst_SetReservedLowMemory|SetReservedLowMemory]]
Line 227: Line 227:
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SetStdFolder|SetStdFolder]]
 
| [[PXV:IPXV_Inst_SetStdFolder|SetStdFolder]]
−
| ...
+
| Changes location of special program folder.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SetupMeasureEditFilter|SetupMeasureEditFilter]]
 
| [[PXV:IPXV_Inst_SetupMeasureEditFilter|SetupMeasureEditFilter]]
−
| ...
+
| Prepares editbox control to show/edit values in specified unit of measurement.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ShowChooseFontDlg|ShowChooseFontDlg]]
 
| [[PXV:IPXV_Inst_ShowChooseFontDlg|ShowChooseFontDlg]]
−
| ...
+
| Displays built-in dialog for choosing font.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ShowCmdBar|ShowCmdBar]]
 
| [[PXV:IPXV_Inst_ShowCmdBar|ShowCmdBar]]
−
| ...
+
| Shows/hides toolbar by specified string identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ShowCmdBar2|ShowCmdBar2]]
 
| [[PXV:IPXV_Inst_ShowCmdBar2|ShowCmdBar2]]
−
| ...
+
| Shows/hides toolbar by specified numeric identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ShowCreateFileErrDlg|ShowCreateFileErrDlg]]
 
| [[PXV:IPXV_Inst_ShowCreateFileErrDlg|ShowCreateFileErrDlg]]
−
| ...
+
| Displays message with user-friendly description of file creation error. Provides additional options for user.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ShowEditActionListDlg|ShowEditActionListDlg]]
 
| [[PXV:IPXV_Inst_ShowEditActionListDlg|ShowEditActionListDlg]]
−
| ...
+
| Displays built-in dialog for edit specified PDF-actions list.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_Shutdown|Shutdown]]
 
| [[PXV:IPXV_Inst_Shutdown|Shutdown]]
−
| ...
+
| Closes the main instance object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_StartLoadingPlugins|StartLoadingPlugins]]
 
| [[PXV:IPXV_Inst_StartLoadingPlugins|StartLoadingPlugins]]
−
| ...
+
| Begins the plugins loading mode for the instance. This method can be called only once.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_StartTimer|StartTimer]]
 
| [[PXV:IPXV_Inst_StartTimer|StartTimer]]
−
| ...
+
| Starts new custom timer.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_StopAllTimers|StopAllTimers]]
 
| [[PXV:IPXV_Inst_StopAllTimers|StopAllTimers]]
−
| ...
+
| Stops all custom timers by specified timer-handler.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_StopTimer|StopTimer]]
 
| [[PXV:IPXV_Inst_StopTimer|StopTimer]]
−
| ...
+
| Stops the custom timer.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_Str2ID|Str2ID]]
 
| [[PXV:IPXV_Inst_Str2ID|Str2ID]]
−
| ...
+
| Converts string identifier to numerical identifier.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_Str2Number|Str2Number]]
 
| [[PXV:IPXV_Inst_Str2Number|Str2Number]]
−
| ...
+
| Converts text to number.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SyncronizeAllDocPanesLayouts|SyncronizeAllDocPanesLayouts]]
 
| [[PXV:IPXV_Inst_SyncronizeAllDocPanesLayouts|SyncronizeAllDocPanesLayouts]]
−
| ...
+
| Makes equal UI-panes layout in all opened documents.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ThreadSafeCall|ThreadSafeCall]]
 
| [[PXV:IPXV_Inst_ThreadSafeCall|ThreadSafeCall]]
−
| ...
+
| Calls in main thread the <code>OnThreadSafeCall()</code> function of specified '''IPXV_ThreadSafeCallback''' callback-interface.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_UnregisterDocSelectionHandler|UnregisterDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_UnregisterDocSelectionHandler|UnregisterDocSelectionHandler]]
−
| ...
+
| Unregister document selection handler.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_UnregisterOpCreator|UnregisterOpCreator]]
 
| [[PXV:IPXV_Inst_UnregisterOpCreator|UnregisterOpCreator]]
−
| ...
+
| Unregister operations creator.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_UnregisterViewCreator|UnregisterViewCreator]]
 
| [[PXV:IPXV_Inst_UnregisterViewCreator|UnregisterViewCreator]]
−
| ...
+
| Unregisters a creator of common UI-objects that implements '''IPXV_View''' interface.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_UpdateProp|UpdateProp]]
 
| [[PXV:IPXV_Inst_UpdateProp|UpdateProp]]
−
| ...
+
| Updates specified property item im '''Properties Pane'''.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_UpdateProps|UpdateProps]]
 
| [[PXV:IPXV_Inst_UpdateProps|UpdateProps]]
−
| ...
+
| Updates all UI that shows properties of selection (properties pane, toolbar, etc)..
 
|}
 
|}
  
Line 299: Line 299:
 
| [[PXV:IPXV_Inst_ActionHandlersCount|ActionHandlersCount]]
 
| [[PXV:IPXV_Inst_ActionHandlersCount|ActionHandlersCount]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets number of registered handlers of PDF-actions.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActiveDoc|ActiveDoc]]
 
| [[PXV:IPXV_Inst_ActiveDoc|ActiveDoc]]
 
| style="text-align: center" | R/W
 
| style="text-align: center" | R/W
−
| .
+
| Gets/sets active document.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActiveDocView|ActiveDocView]]
 
| [[PXV:IPXV_Inst_ActiveDocView|ActiveDocView]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets active document view object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActiveMainView|ActiveMainView]]
 
| [[PXV:IPXV_Inst_ActiveMainView|ActiveMainView]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets active main view object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AnnotStateModelManager|AnnotStateModelManager]]
 
| [[PXV:IPXV_Inst_AnnotStateModelManager|AnnotStateModelManager]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets annotation-state models manager.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_APIVersion|APIVersion]]
 
| [[PXV:IPXV_Inst_APIVersion|APIVersion]]
Line 327: Line 327:
 
| [[PXV:IPXV_Inst_CommentStylesManager|CommentStylesManager]]
 
| [[PXV:IPXV_Inst_CommentStylesManager|CommentStylesManager]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets manager of comment-styles.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_DefaultProgressMon|DefaultProgressMon]]
 
| [[PXV:IPXV_Inst_DefaultProgressMon|DefaultProgressMon]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets default progress monitor.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_DefaultTool|DefaultTool]]
 
| [[PXV:IPXV_Inst_DefaultTool|DefaultTool]]
 
| style="text-align: center" | R/W
 
| style="text-align: center" | R/W
−
| .
+
| Gets/sets the default tool.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_DefaultToolID|DefaultToolID]]
 
| [[PXV:IPXV_Inst_DefaultToolID|DefaultToolID]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets identifier of default tool.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_DispMeasureUnit|DispMeasureUnit]]
 
| [[PXV:IPXV_Inst_DispMeasureUnit|DispMeasureUnit]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets current unit of measurement.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_Doc|Doc]]
 
| [[PXV:IPXV_Inst_Doc|Doc]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets opened document by specified index.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_DocCount|DocCount]]
 
| [[PXV:IPXV_Inst_DocCount|DocCount]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets number of opened documents.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_EventServer|EventServer]]
 
| [[PXV:IPXV_Inst_EventServer|EventServer]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets global event-server object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_EventsRegistry|EventsRegistry]]
 
| [[PXV:IPXV_Inst_EventsRegistry|EventsRegistry]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets global events registry object.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ExportConverter|ExportConverter]]
 
| [[PXV:IPXV_Inst_ExportConverter|ExportConverter]]
Line 379: Line 379:
 
| [[PXV:IPXV_Inst_IsHistoryLoaded|IsHistoryLoaded]]
 
| [[PXV:IPXV_Inst_IsHistoryLoaded|IsHistoryLoaded]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets history loaded flag.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_IsPortable|IsPortable]]
 
| [[PXV:IPXV_Inst_IsPortable|IsPortable]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets portable application flag.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_LastActiveTool|LastActiveTool]]
 
| [[PXV:IPXV_Inst_LastActiveTool|LastActiveTool]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets last activated tool.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_LastActiveToolID|LastActiveToolID]]
 
| [[PXV:IPXV_Inst_LastActiveToolID|LastActiveToolID]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets identifier of last activated tool.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_MainFrm|MainFrm]]
 
| [[PXV:IPXV_Inst_MainFrm|MainFrm]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets main frame object by specified index.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_MainFrmCount|MainFrmCount]]
 
| [[PXV:IPXV_Inst_MainFrmCount|MainFrmCount]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets the number of opened main frames.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ProgressMon|ProgressMon]]
 
| [[PXV:IPXV_Inst_ProgressMon|ProgressMon]]
 
| style="text-align: center" | R/W
 
| style="text-align: center" | R/W
−
| .
+
| Gets/sets progress actual monitor.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_SelectedStamp|SelectedStamp]]
 
| [[PXV:IPXV_Inst_SelectedStamp|SelectedStamp]]
Line 411: Line 411:
 
| [[PXV:IPXV_Inst_Settings|Settings]]
 
| [[PXV:IPXV_Inst_Settings|Settings]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Gets object that provides access to all application's settings.
 
|-
 
|-
 
| [[PXV:IPXV_Inst_State|State]]
 
| [[PXV:IPXV_Inst_State|State]]
Line 419: Line 419:
 
| [[PXV:IPXV_Inst_ThreadID|ThreadID]]
 
| [[PXV:IPXV_Inst_ThreadID|ThreadID]]
 
| style="text-align: center" | R
 
| style="text-align: center" | R
−
| .
+
| Returns identifier of main thread.
 
|}
 
|}

Revision as of 02:33, 21 March 2015

The interface of general object of PDF-XChange Editor SDK. Inherits from the IDispatch interface.

Methods

Method Description
AddDefaultTranslationData Adds special xml with default(built-in) strings for UI-localization. Each module(plug-in) can add its own default strings inside his IPXV_Plugin::FinalizeRegistering() procedure.
AddPlugin Adds a plugin object to the instance.
AddPluginFromFile Adds a plugin to the instance from specified file.  Function can be called only in plugins loading mode.
AsyncDo Runs the specified operation in background thread.
AsyncDoAndWaitForFinish Run operation in background thread and wait (with non-blocking UI) for finish.
ClearHistory Removes documents opening history entirely.
CreateAnnotsList Creates new container: annotations list.
CreateBookmList Creates new container: bookmarks list.
CreateMeasureUnitsConvTbl Creates an special conversion-table to translate on-fly the entered by user value from other units to current unit.
CreateNewMainFrm Creates new main frame window.
CreateOp Creates new operation-object.
CreateOpenDocParams Creates structured container of parameters that might be used for opening documents.
CreatePageSizeCtl Creates UI-control to show/change the page size..
CreatePageSizeHelper ...
CreateStdPresetsButton Creates new presets button to provide to user the simple access to presets list.
CreateStdPresetsCallbacks Creates new standard presets management helper.
CreateStdRangeCtl Creates special UI-control to show/change the pages range.
ExecUICmd Runs the UI-command specified by unigue name.
ExecUICmd2 Runs the UI-command specified by unigue identifier.
ExecuteJS Executes the specified Java Script.
FindDocByCoreDoc Finds opened document by pointer to core-document object.
FindDocByID Finds opened document by unique identifier.
FindDocBySrcFile Finds opened document by pointer to source file object.
FindDocBySrcFileName Finds opened document by pointer source file name object.
FindDocBySrcFileName2 Finds opened document by source file name.
FinishLoadingPlugins Finish a loading plugins mode for the instance. This method can be called only once.
FireAppPrefsChanged Notifies all listeners about changes of preferences in specified category.
FireAppPrefsChanged2 Notifies all listeners about complex changes of preferences.
FireCmdCustomizationEvent Notifies all listeners about new customization of toolbars/menus.
FormatFileSize Formats file size as text for display.
FormatMeasureValue Formats measurement value.
FormatNumber ...
GetActionHandler ...
GetAnnotHandler Gets handler for PDF-annotation.
GetDlgParentWindow Gets handle of right parent window for dialog that will be displayed for specified document.
GetDocSelectionHandler Gets document selection handler by specified document and selection-object.
GetExtension Gets an extension by its unique name.
GetHandlerForAction Gets the PDF-action handler by action type identifier.
GetLocalNameForSave Shows Save File dialog and gets destination file name that is specified by user.
GetLocalNamesForOpen Shows Open File dialog and gets the file(s) chosed by user to open.
GetLocalPathName Show Select Folder dialog and gets destination folder path that is specified by user.
GetLocalStr Gets localized string by specified unique string indentifier.
GetLocalStr2 Gets localized string by specified unique numerical indentifier.
GetMeasureUnitInfo Gets special info about specified unit of measurement.
GetPathToHistory Gets path to source of document opening history.
GetPathToUserSettings Gets path to source of user's preferences.
GetPluginSettings Gets reference to node in application's options-storage that contains all settings of specified plugin.
GetPrinters Gets names list of all installed printers.
GetStdFolder Gets full path to special program folder.
GetTextFromHRes Gets user friendly decription text of error- of warning- code value(HRESULT).
GetTool Gets the tool object by specified identifier of tool.
ID2Str Converts numerical identifier that was previously obtained by Str2ID  to corresponding string identifier.
Init Initializes the main instance object.
IsCmdBarVisible Gets visibility state of toolbar.
IsCmdBarVisible2 Gets visibility state of toolbar.
ModifyCoreDoc Changes modified state of the core-document.
ModifyDoc Changes modified state of the opened document.
NewCoreDoc ...
PerformActions Executes the PDF-action.
RegisterActionHandler Registers new PDF-action handler.
RegisterDocSelectionHandler Registers new document selection handler.
RegisterExportConverter Registers new export-PDF-to-other converter.
RegisterExtension Registers a custom extension.
RegisterImportConverter Registers new import-something -to-PDF converter.
RegisterOpCreator Registers new creator for operations.
RegisterTool Registers new tool-object that extends interaction level for pages view.
RegisterViewCreator Registers new creator of common UI-objects that implements IPXV_View interface.
ResetCmdCustomization Removes toolbars customization.
RestartTimer Restarts the custom timer.
SaveHistory Saves documents opening history to specified storage.
SaveUserSettings Save all user's preferences to specified storage.
SetReservedLowMemory ...
SetStdFolder Changes location of special program folder.
SetupMeasureEditFilter Prepares editbox control to show/edit values in specified unit of measurement.
ShowChooseFontDlg Displays built-in dialog for choosing font.
ShowCmdBar Shows/hides toolbar by specified string identifier.
ShowCmdBar2 Shows/hides toolbar by specified numeric identifier.
ShowCreateFileErrDlg Displays message with user-friendly description of file creation error. Provides additional options for user.
ShowEditActionListDlg Displays built-in dialog for edit specified PDF-actions list.
Shutdown Closes the main instance object.
StartLoadingPlugins Begins the plugins loading mode for the instance. This method can be called only once.
StartTimer Starts new custom timer.
StopAllTimers Stops all custom timers by specified timer-handler.
StopTimer Stops the custom timer.
Str2ID Converts string identifier to numerical identifier.
Str2Number Converts text to number.
SyncronizeAllDocPanesLayouts Makes equal UI-panes layout in all opened documents.
ThreadSafeCall Calls in main thread the OnThreadSafeCall() function of specified IPXV_ThreadSafeCallback callback-interface.
UnregisterDocSelectionHandler Unregister document selection handler.
UnregisterOpCreator Unregister operations creator.
UnregisterViewCreator Unregisters a creator of common UI-objects that implements IPXV_View interface.
UpdateProp Updates specified property item im Properties Pane.
UpdateProps Updates all UI that shows properties of selection (properties pane, toolbar, etc)..

Properties

Property Access Type Description
ActionHandlersCount R Gets number of registered handlers of PDF-actions.
ActiveDoc R/W Gets/sets active document.
ActiveDocView R Gets active document view object.
ActiveMainView R Gets active main view object.
AnnotStateModelManager R Gets annotation-state models manager.
APIVersion R .
AppType R .
CommentStylesManager R Gets manager of comment-styles.
DefaultProgressMon R Gets default progress monitor.
DefaultTool R/W Gets/sets the default tool.
DefaultToolID R Gets identifier of default tool.
DispMeasureUnit R Gets current unit of measurement.
Doc R Gets opened document by specified index.
DocCount R Gets number of opened documents.
EventServer R Gets global event-server object.
EventsRegistry R Gets global events registry object.
ExportConverter R .
ExportConvertersCount R .
ImportConverter R .
ImportConvertersCount R .
IsHistoryLoaded R Gets history loaded flag.
IsPortable R Gets portable application flag.
LastActiveTool R Gets last activated tool.
LastActiveToolID R Gets identifier of last activated tool.
MainFrm R Gets main frame object by specified index.
MainFrmCount R Gets the number of opened main frames.
ProgressMon R/W Gets/sets progress actual monitor.
SelectedStamp R/W .
Settings R Gets object that provides access to all application's settings.
State R .
ThreadID R Returns identifier of main thread.
Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXV_Inst&oldid=4385"