IPXV_Inst Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst Interface}}
 
{{#customTitle:IPXV_Inst Interface}}
 +
{{#parentPage:PXV:PXV_Interfaces|IPXV_Inst|interface}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The interface of general object of PDF-XChange Editor SDK. Inherits from the '''IDispatch''' interface.
 
The interface of general object of PDF-XChange Editor SDK. Inherits from the '''IDispatch''' interface.
  
 
== Methods ==
 
== Methods ==
−
{| class="wikitable sortable collapsible" style="width: 100%"
+
{| class="wikitable methods"
−
|-
+
−
! style="text-align: left" scope="col" width="15%" | Method
+
−
! style="text-align: left" scope="col" class="unsortable" | Description
+
 
|-
 
|-
 
| [[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_FindDocByCoreDoc|FindDocByCoreDoc]]
 +
| [[PXV:IPXV_Inst_ID2Str|ID2Str]]
 +
| [[PXV:IPXV_Inst_SetLicKey|SetLicKey]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AddPlugin|AddPlugin]]
 
| [[PXV:IPXV_Inst_AddPlugin|AddPlugin]]
−
| Adds a plugin object to the instance.
+
| [[PXV:IPXV_Inst_FindDocByID|FindDocByID]]
 +
| [[PXV:IPXV_Inst_Init|Init]]
 +
| [[PXV:IPXV_Inst_SetMainWindow|SetMainWindow]]
 
|-
 
|-
 
| [[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_FindDocBySrcFile|FindDocBySrcFile]]
 +
| [[PXV:IPXV_Inst_IsCmdBarVisible|IsCmdBarVisible]]
 +
| [[PXV:IPXV_Inst_SetReservedLowMemory|SetReservedLowMemory]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_AsyncDo|AsyncDo]]
 
| [[PXV:IPXV_Inst_AsyncDo|AsyncDo]]
−
| Runs the specified operation in background thread.
+
| [[PXV:IPXV_Inst_FindDocBySrcFileName|FindDocBySrcFileName]]
 +
| [[PXV:IPXV_Inst_IsCmdBarVisible2|IsCmdBarVisible2]]
 +
| [[PXV:IPXV_Inst_SetStdFolder|SetStdFolder]]
 
|-
 
|-
 
| [[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_FindDocBySrcFileName2|FindDocBySrcFileName2]]
 +
| [[PXV:IPXV_Inst_LoadHistory|LoadHistory]]
 +
| [[PXV:IPXV_Inst_SetupMeasureEditFilter|SetupMeasureEditFilter]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ClearHistory|ClearHistory]]
 
| [[PXV:IPXV_Inst_ClearHistory|ClearHistory]]
−
| Removes documents opening history entirely.
+
| [[PXV:IPXV_Inst_FinishLoadingPlugins|FinishLoadingPlugins]]
 +
| [[PXV:IPXV_Inst_LoadUserSettings|LoadUserSettings]]
 +
| [[PXV:IPXV_Inst_SetupOperPagesRange|SetupOperPagesRange]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_CreateAnnotsList|CreateAnnotsList]]
 
| [[PXV:IPXV_Inst_CreateAnnotsList|CreateAnnotsList]]
−
| Creates new container: annotations list.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateBookmList|CreateBookmList]]
 
−
| Creates new container: bookmarks list.
 
−
|-
 
−
| [[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]]
 
−
| Creates new main frame window.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateOp|CreateOp]]
 
−
| Creates new operation-object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateOpenDocParams|CreateOpenDocParams]]
 
−
| Creates structured container of parameters that might be used for opening documents.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreatePageSizeCtl|CreatePageSizeCtl]]
 
−
| Creates UI-control to show/change the page size..
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreatePageSizeHelper|CreatePageSizeHelper]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateStdPresetsButton|CreateStdPresetsButton]]
 
−
| Creates new presets button to provide to user the simple access to presets list.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateStdPresetsCallbacks|CreateStdPresetsCallbacks]]
 
−
| Creates new standard presets management helper.
 
−
|-
 
−
| [[PXV:IPXV_Inst_CreateStdRangeCtl|CreateStdRangeCtl]]
 
−
| Creates special UI-control to show/change the pages range.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ExecUICmd|ExecUICmd]]
 
−
| Runs the UI-command specified by unigue name.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ExecUICmd2|ExecUICmd2]]
 
−
| Runs the UI-command specified by unigue identifier.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ExecuteJS|ExecuteJS]]
 
−
| Executes the specified Java Script.
 
−
|-
 
−
| [[PXV:IPXV_Inst_FindDocByCoreDoc|FindDocByCoreDoc]]
 
−
| Finds opened document by pointer to core-document object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_FindDocByID|FindDocByID]]
 
−
| Finds opened document by unique identifier.
 
−
|-
 
−
| [[PXV:IPXV_Inst_FindDocBySrcFile|FindDocBySrcFile]]
 
−
| Finds opened document by pointer to source file object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_FindDocBySrcFileName|FindDocBySrcFileName]]
 
−
| Finds opened document by pointer source file name object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_FindDocBySrcFileName2|FindDocBySrcFileName2]]
 
−
| Finds opened document by source file name.
 
−
|-
 
−
| [[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_LockCmdCustomizationEvent|LockCmdCustomizationEvent]]
 +
| [[PXV:IPXV_Inst_ShowAppPrefsDlg|ShowAppPrefsDlg]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateAttachList|CreateAttachList]]
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged2|FireAppPrefsChanged2]]
 
| [[PXV:IPXV_Inst_FireAppPrefsChanged2|FireAppPrefsChanged2]]
−
| Notifies all listeners about complex changes of preferences.
+
| [[PXV:IPXV_Inst_ModifyCoreDoc|ModifyCoreDoc]]
 +
| [[PXV:IPXV_Inst_ShowChooseFontDlg|ShowChooseFontDlg]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateBookmList|CreateBookmList]]
 
| [[PXV:IPXV_Inst_FireCmdCustomizationEvent|FireCmdCustomizationEvent]]
 
| [[PXV:IPXV_Inst_FireCmdCustomizationEvent|FireCmdCustomizationEvent]]
−
| Notifies all listeners about new customization of toolbars/menus.
+
| [[PXV:IPXV_Inst_ModifyDoc|ModifyDoc]]
 +
| [[PXV:IPXV_Inst_ShowCmdBar|ShowCmdBar]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateCIEntry|CreateCIEntry]]
 
| [[PXV:IPXV_Inst_FormatFileSize|FormatFileSize]]
 
| [[PXV:IPXV_Inst_FormatFileSize|FormatFileSize]]
−
| Formats file size as text for display.
+
| [[PXV:IPXV_Inst_NewCoreDoc|NewCoreDoc]]
 +
| [[PXV:IPXV_Inst_ShowCmdBar2|ShowCmdBar2]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateDocList|CreateDocList]]
 
| [[PXV:IPXV_Inst_FormatMeasureValue|FormatMeasureValue]]
 
| [[PXV:IPXV_Inst_FormatMeasureValue|FormatMeasureValue]]
−
| Formats measurement value.
+
| [[PXV:IPXV_Inst_OpenPlace|OpenPlace]]
 +
| [[PXV:IPXV_Inst_ShowCreateFileErrDlg|ShowCreateFileErrDlg]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateFileNamesProvider|CreateFileNamesProvider]]
 
| [[PXV:IPXV_Inst_FormatNumber|FormatNumber]]
 
| [[PXV:IPXV_Inst_FormatNumber|FormatNumber]]
−
| ...
+
| [[PXV:IPXV_Inst_PathToName|PathToName]]
−
|-
+
| [[PXV:IPXV_Inst_ShowEditActionListDlg|ShowEditActionListDlg]]
−
| [[PXV:IPXV_Inst_GetActionHandler|GetActionHandler]]
+
−
| ...
+
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateMacroHelper|CreateMacroHelper]]
 
| [[PXV:IPXV_Inst_GetAnnotHandler|GetAnnotHandler]]
 
| [[PXV:IPXV_Inst_GetAnnotHandler|GetAnnotHandler]]
−
| Gets handler for PDF-annotation.
+
| [[PXV:IPXV_Inst_PerformActions|PerformActions]]
 +
| [[PXV:IPXV_Inst_ShowMsgBox|ShowMsgBox]]
 
|-
 
|-
−
| [[PXV:IPXV_Inst_GetDlgParentWindow|GetDlgParentWindow]]
+
| [[PXV:IPXV_Inst_CreateMeasureUnitsConvTbl|CreateMeasureUnitsConvTbl]]
−
| Gets handle of right parent window for dialog that will be displayed for specified document.
+
| [[PXV:IPXV_Inst_GetCryptKey|GetCryptKey]]
 +
| [[PXV:IPXV_Inst_RefreshOAuthToken|RefreshOAuthToken]]
 +
| [[PXV:IPXV_Inst_ShowMsgBoxEx|ShowMsgBoxEx]]
 
|-
 
|-
−
| [[PXV:IPXV_Inst_GetDocSelectionHandler|GetDocSelectionHandler]]
+
| [[PXV:IPXV_Inst_CreateNewMainFrm|CreateNewMainFrm]]
−
| Gets document selection handler by specified document and selection-object.
+
| [[PXV:IPXV_Inst_GetCurrentUILang|GetCurrentUILang]]
 +
| [[PXV:IPXV_Inst_RegisterActionHandler|RegisterActionHandler]]
 +
| [[PXV:IPXV_Inst_ShowMsgBoxWithOpt|ShowMsgBoxWithOpt]]
 
|-
 
|-
−
| [[PXV:IPXV_Inst_GetExtension|GetExtension]]
+
| [[PXV:IPXV_Inst_CreateOAuthParams|CreateOAuthParams]]
−
| Gets an extension by its unique name.
+
| [[PXV:IPXV_Inst_GetDefaultPrinter|GetDefaultPrinter]]
−
|-
+
| [[PXV:IPXV_Inst_RegisterDocInfoBarSpan|RegisterDocInfoBarSpan]]
−
| [[PXV:IPXV_Inst_GetHandlerForAction|GetHandlerForAction]]
+
| [[PXV:IPXV_Inst_ShowOpenFilesDlg|ShowOpenFilesDlg]]
−
| Gets the PDF-action handler by action type identifier.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetLocalNameForSave|GetLocalNameForSave]]
+
−
| Shows '''Save File''' dialog and gets destination file name that is specified by user.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetLocalNamesForOpen|GetLocalNamesForOpen]]
+
−
| Shows '''Open File''' dialog and gets the file(s) chosed by user to open.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetLocalPathName|GetLocalPathName]]
+
−
| Show '''Select Folder''' dialog and gets destination folder path that is specified by user.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetLocalStr|GetLocalStr]]
+
−
| Gets localized string by specified unique string indentifier.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetLocalStr2|GetLocalStr2]]
+
−
| Gets localized string by specified unique numerical indentifier.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetMeasureUnitInfo|GetMeasureUnitInfo]]
+
−
| Gets special info about specified unit of measurement.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetPathToHistory|GetPathToHistory]]
+
−
| Gets path to source of document opening history.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetPathToUserSettings|GetPathToUserSettings]]
+
−
| Gets path to source of user's preferences.
+
−
|-
+
−
| [[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]]
+
−
| Gets names list of all installed printers.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetStdFolder|GetStdFolder]]
+
−
| Gets full path to special program folder.
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetTextFromHRes|GetTextFromHRes]]
+
−
| Gets user friendly decription text of error- of warning- code value(HRESULT).
+
−
|-
+
−
| [[PXV:IPXV_Inst_GetTool|GetTool]]
+
−
| Gets the tool object by specified identifier of tool.
+
−
|-
+
−
| [[PXV:IPXV_Inst_ID2Str|ID2Str]]
+
−
| Converts numerical identifier that was previously obtained by Str2ID&nbsp; to corresponding string identifier.
+
−
|-
+
−
| [[PXV:IPXV_Inst_Init|Init]]
+
−
| Initializes the main instance object.
+
−
|-
+
−
| [[PXV:IPXV_Inst_IsCmdBarVisible|IsCmdBarVisible]]
+
−
| Gets visibility state of toolbar.
+
−
|-
+
−
| [[PXV:IPXV_Inst_IsCmdBarVisible2|IsCmdBarVisible2]]
+
−
| Gets visibility state of toolbar.
+
−
|-
+
−
| [[PXV:IPXV_Inst_ModifyCoreDoc|ModifyCoreDoc]]
+
−
| Changes '''modified''' state of the core-document.
+
−
|-
+
−
| [[PXV:IPXV_Inst_ModifyDoc|ModifyDoc]]
+
−
| Changes '''modified''' state of the opened document.
+
−
|-
+
−
| [[PXV:IPXV_Inst_NewCoreDoc|NewCoreDoc]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IPXV_Inst_PerformActions|PerformActions]]
+
−
| Executes the PDF-action.
+
−
|-
+
−
| [[PXV:IPXV_Inst_RegisterActionHandler|RegisterActionHandler]]
+
−
| Registers new PDF-action handler.
+
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateOp|CreateOp]]
 +
| [[PXV:IPXV_Inst_GetDlgParentWindow|GetDlgParentWindow]]
 
| [[PXV:IPXV_Inst_RegisterDocSelectionHandler|RegisterDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_RegisterDocSelectionHandler|RegisterDocSelectionHandler]]
−
| Registers new document selection handler.
+
| [[PXV:IPXV_Inst_ShowRibbonTab|ShowRibbonTab]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateOpenDocParams|CreateOpenDocParams]]
 +
| [[PXV:IPXV_Inst_GetDocFeaturePermission|GetDocFeaturePermission]]
 
| [[PXV:IPXV_Inst_RegisterExportConverter|RegisterExportConverter]]
 
| [[PXV:IPXV_Inst_RegisterExportConverter|RegisterExportConverter]]
−
| Registers new export-PDF-to-other converter.
+
| [[PXV:IPXV_Inst_ShowRibbonTab2|ShowRibbonTab2]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreatePageSizeCtl|CreatePageSizeCtl]]
 +
| [[PXV:IPXV_Inst_GetDocFeaturePermission2|GetDocFeaturePermission2]]
 
| [[PXV:IPXV_Inst_RegisterExtension|RegisterExtension]]
 
| [[PXV:IPXV_Inst_RegisterExtension|RegisterExtension]]
−
| Registers a custom extension.
+
| [[PXV:IPXV_Inst_ShowSaveFileDlg|ShowSaveFileDlg]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreatePagesPreviewCtl|CreatePagesPreviewCtl]]
 +
| [[PXV:IPXV_Inst_GetDocSelectionHandler|GetDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_RegisterImportConverter|RegisterImportConverter]]
 
| [[PXV:IPXV_Inst_RegisterImportConverter|RegisterImportConverter]]
−
| Registers new import-something -to-PDF converter.
+
| [[PXV:IPXV_Inst_ShowSelectFolderDlg|ShowSelectFolderDlg]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreatePlaceProvidersListCtl|CreatePlaceProvidersListCtl]]
 +
| [[PXV:IPXV_Inst_GetDocViewFromUIObj|GetDocViewFromUIObj]]
 
| [[PXV:IPXV_Inst_RegisterOpCreator|RegisterOpCreator]]
 
| [[PXV:IPXV_Inst_RegisterOpCreator|RegisterOpCreator]]
−
| Registers new creator for operations.
 
−
|-
 
−
| [[PXV:IPXV_Inst_RegisterTool|RegisterTool]]
 
−
| Registers new tool-object that extends interaction level for pages view.
 
−
|-
 
−
| [[PXV:IPXV_Inst_RegisterViewCreator|RegisterViewCreator]]
 
−
| Registers new creator of common UI-objects that implements '''IPXV_View''' interface.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ResetCmdCustomization|ResetCmdCustomization]]
 
−
| Removes toolbars customization.
 
−
|-
 
−
| [[PXV:IPXV_Inst_RestartTimer|RestartTimer]]
 
−
| Restarts the custom timer.
 
−
|-
 
−
| [[PXV:IPXV_Inst_SaveHistory|SaveHistory]]
 
−
| Saves documents opening history to specified storage.
 
−
|-
 
−
| [[PXV:IPXV_Inst_SaveUserSettings|SaveUserSettings]]
 
−
| Save all user's preferences to specified storage.
 
−
|-
 
−
| [[PXV:IPXV_Inst_SetReservedLowMemory|SetReservedLowMemory]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IPXV_Inst_SetStdFolder|SetStdFolder]]
 
−
| Changes location of special program folder.
 
−
|-
 
−
| [[PXV:IPXV_Inst_SetupMeasureEditFilter|SetupMeasureEditFilter]]
 
−
| Prepares editbox control to show/edit values in specified unit of measurement.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ShowChooseFontDlg|ShowChooseFontDlg]]
 
−
| Displays built-in dialog for choosing font.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ShowCmdBar|ShowCmdBar]]
 
−
| Shows/hides toolbar by specified string identifier.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ShowCmdBar2|ShowCmdBar2]]
 
−
| Shows/hides toolbar by specified numeric identifier.
 
−
|-
 
−
| [[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]]
 
−
| 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_CreatePlacesListCtl|CreatePlacesListCtl]]
 +
| [[PXV:IPXV_Inst_GetExtension|GetExtension]]
 +
| [[PXV:IPXV_Inst_RegisterSignatureProvider|RegisterSignatureProvider]]
 
| [[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_CreateStdBindContext|CreateStdBindContext]]
 +
| [[PXV:IPXV_Inst_GetFormatConverterIndex|GetFormatConverterIndex]]
 +
| [[PXV:IPXV_Inst_RegisterTool|RegisterTool]]
 
| [[PXV:IPXV_Inst_StartTimer|StartTimer]]
 
| [[PXV:IPXV_Inst_StartTimer|StartTimer]]
−
| Starts new custom timer.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateStdPresetsButton|CreateStdPresetsButton]]
 +
| [[PXV:IPXV_Inst_GetFormatConverterParams|GetFormatConverterParams]]
 +
| [[PXV:IPXV_Inst_RegisterViewCreator|RegisterViewCreator]]
 
| [[PXV:IPXV_Inst_StopAllTimers|StopAllTimers]]
 
| [[PXV:IPXV_Inst_StopAllTimers|StopAllTimers]]
−
| Stops all custom timers by specified timer-handler.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateStdPresetsCallbacks|CreateStdPresetsCallbacks]]
 +
| [[PXV:IPXV_Inst_GetHandlerForAction|GetHandlerForAction]]
 +
| [[PXV:IPXV_Inst_ResetAllDocFeaturesPermissions|ResetAllDocFeaturesPermissions]]
 
| [[PXV:IPXV_Inst_StopTimer|StopTimer]]
 
| [[PXV:IPXV_Inst_StopTimer|StopTimer]]
−
| Stops the custom timer.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateStdRangeCtl|CreateStdRangeCtl]]
 +
| [[PXV:IPXV_Inst_GetLocalStr|GetLocalStr]]
 +
| [[PXV:IPXV_Inst_ResetCmdBar|ResetCmdBar]]
 
| [[PXV:IPXV_Inst_Str2ID|Str2ID]]
 
| [[PXV:IPXV_Inst_Str2ID|Str2ID]]
−
| Converts string identifier to numerical identifier.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_CreateString|CreateString]]
 +
| [[PXV:IPXV_Inst_GetLocalStr2|GetLocalStr2]]
 +
| [[PXV:IPXV_Inst_ResetCmdBar2|ResetCmdBar2]]
 
| [[PXV:IPXV_Inst_Str2Number|Str2Number]]
 
| [[PXV:IPXV_Inst_Str2Number|Str2Number]]
−
| Converts text to number.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_DeleteCmdBar|DeleteCmdBar]]
 +
| [[PXV:IPXV_Inst_GetLocalStrID|GetLocalStrID]]
 +
| [[PXV:IPXV_Inst_ResetCmdCustomization|ResetCmdCustomization]]
 
| [[PXV:IPXV_Inst_SyncronizeAllDocPanesLayouts|SyncronizeAllDocPanesLayouts]]
 
| [[PXV:IPXV_Inst_SyncronizeAllDocPanesLayouts|SyncronizeAllDocPanesLayouts]]
−
| Makes equal UI-panes layout in all opened documents.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_DeleteCmdBar2|DeleteCmdBar2]]
 +
| [[PXV:IPXV_Inst_GetLocalStrID2|GetLocalStrID2]]
 +
| [[PXV:IPXV_Inst_RestartTimer|RestartTimer]]
 +
| [[PXV:IPXV_Inst_SyncronizeCmdCustomization|SyncronizeCmdCustomization]]
 +
|-
 +
| [[PXV:IPXV_Inst_DoOAuth|DoOAuth]]
 +
| [[PXV:IPXV_Inst_GetMainViewFromUIObj|GetMainViewFromUIObj]]
 +
| [[PXV:IPXV_Inst_RevertDoc|RevertDoc]]
 
| [[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_EditImage|EditImage]]
 +
| [[PXV:IPXV_Inst_GetMeasureUnitInfo|GetMeasureUnitInfo]]
 +
| [[PXV:IPXV_Inst_RevertDoc2|RevertDoc2]]
 +
| [[PXV:IPXV_Inst_ThreadSafeCall2|ThreadSafeCall2]]
 +
|-
 +
| [[PXV:IPXV_Inst_EditImageFmtParams|EditImageFmtParams]]
 +
| [[PXV:IPXV_Inst_GetPlaceInfo|GetPlaceInfo]]
 +
| [[PXV:IPXV_Inst_SaveHistory|SaveHistory]]
 +
| [[PXV:IPXV_Inst_UnlockCmdCustomizationEvent|UnlockCmdCustomizationEvent]]
 +
|-
 +
| [[PXV:IPXV_Inst_EnableRibbonUI|EnableRibbonUI]]
 +
| [[PXV:IPXV_Inst_GetPluginSettings|GetPluginSettings]]
 +
| [[PXV:IPXV_Inst_SaveUserSettings|SaveUserSettings]]
 
| [[PXV:IPXV_Inst_UnregisterDocSelectionHandler|UnregisterDocSelectionHandler]]
 
| [[PXV:IPXV_Inst_UnregisterDocSelectionHandler|UnregisterDocSelectionHandler]]
−
| Unregister document selection handler.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ExecUICmd|ExecUICmd]]
 +
| [[PXV:IPXV_Inst_GetPrinters|GetPrinters]]
 +
| [[PXV:IPXV_Inst_SetCurrentUILang|SetCurrentUILang]]
 
| [[PXV:IPXV_Inst_UnregisterOpCreator|UnregisterOpCreator]]
 
| [[PXV:IPXV_Inst_UnregisterOpCreator|UnregisterOpCreator]]
−
| Unregister operations creator.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ExecUICmd2|ExecUICmd2]]
 +
| [[PXV:IPXV_Inst_GetStdFolder|GetStdFolder]]
 +
| [[PXV:IPXV_Inst_SetDocFeaturePermission|SetDocFeaturePermission]]
 
| [[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_ExecuteJS|ExecuteJS]]
 +
| [[PXV:IPXV_Inst_GetTextFromHRes|GetTextFromHRes]]
 +
| [[PXV:IPXV_Inst_SetDocFeaturePermission2|SetDocFeaturePermission2]]
 
| [[PXV:IPXV_Inst_UpdateProp|UpdateProp]]
 
| [[PXV:IPXV_Inst_UpdateProp|UpdateProp]]
−
| Updates specified property item im '''Properties Pane'''.
 
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ExecuteJSEx|ExecuteJSEx]]
 +
| [[PXV:IPXV_Inst_GetTool|GetTool]]
 +
| [[PXV:IPXV_Inst_SetFormatConverterParams|SetFormatConverterParams]]
 
| [[PXV:IPXV_Inst_UpdateProps|UpdateProps]]
 
| [[PXV:IPXV_Inst_UpdateProps|UpdateProps]]
−
| Updates all UI that shows properties of selection (properties pane, toolbar, etc)..
+
|-
 +
| [[PXV:IPXV_Inst_ExpandOpenFileFilterAlias|ExpandOpenFileFilterAlias]]
 +
| [[PXV:IPXV_Inst_GetUILanguages|GetUILanguages]]
 +
|
 +
|
 
|}
 
|}
  
 
== Properties ==
 
== Properties ==
−
{| style="width: 100%" class="wikitable sortable collapsible"
+
{| class="wikitable properties"
 
|-
 
|-
−
! style="text-align: left" scope="col" width="15%" | Property
+
| [[PXV:IPXV_Inst_ActionHandler|ActionHandler]]
−
! style="text-align: center" scope="col" width="5%" | Access Type
+
| [[PXV:IPXV_Inst_AppType|AppType]]
−
! style="text-align: left" scope="col"  class="unsortable" | Description
+
| [[PXV:IPXV_Inst_ExportConverter|ExportConverter]]
 +
| [[PXV:IPXV_Inst_MainFrm|MainFrm]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActionHandlersCount|ActionHandlersCount]]
 
| [[PXV:IPXV_Inst_ActionHandlersCount|ActionHandlersCount]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_CommentStylesManager|CommentStylesManager]]
−
| Gets number of registered handlers of PDF-actions.
+
| [[PXV:IPXV_Inst_ExportConvertersCount|ExportConvertersCount]]
 +
| [[PXV:IPXV_Inst_MainFrmCount|MainFrmCount]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActiveDoc|ActiveDoc]]
 
| [[PXV:IPXV_Inst_ActiveDoc|ActiveDoc]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXV_Inst_DefaultProgressMon|DefaultProgressMon]]
−
| Gets/sets active document.
+
| [[PXV:IPXV_Inst_ImportConverter|ImportConverter]]
 +
| [[PXV:IPXV_Inst_NavHistory|NavHistory]]
 
|-
 
|-
 
| [[PXV:IPXV_Inst_ActiveDocView|ActiveDocView]]
 
| [[PXV:IPXV_Inst_ActiveDocView|ActiveDocView]]
−
| style="text-align: center" | R
 
−
| Gets active document view object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ActiveMainView|ActiveMainView]]
 
−
| style="text-align: center" | R
 
−
| Gets active main view object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_AnnotStateModelManager|AnnotStateModelManager]]
 
−
| style="text-align: center" | R
 
−
| Gets annotation-state models manager.
 
−
|-
 
−
| [[PXV:IPXV_Inst_APIVersion|APIVersion]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_AppType|AppType]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_CommentStylesManager|CommentStylesManager]]
 
−
| style="text-align: center" | R
 
−
| Gets manager of comment-styles.
 
−
|-
 
−
| [[PXV:IPXV_Inst_DefaultProgressMon|DefaultProgressMon]]
 
−
| 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
+
| [[PXV:IPXV_Inst_ImportConvertersCount|ImportConvertersCount]]
−
| Gets/sets the default tool.
+
| [[PXV:IPXV_Inst_ProgressMon|ProgressMon]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ActiveMainFrm|ActiveMainFrm]]
 
| [[PXV:IPXV_Inst_DefaultToolID|DefaultToolID]]
 
| [[PXV:IPXV_Inst_DefaultToolID|DefaultToolID]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_IsGlobalNavHistory|IsGlobalNavHistory]]
−
| Gets identifier of default tool.
+
| [[PXV:IPXV_Inst_SelectedStamp|SelectedStamp]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ActiveMainFrmWndHandle|ActiveMainFrmWndHandle]]
 
| [[PXV:IPXV_Inst_DispMeasureUnit|DispMeasureUnit]]
 
| [[PXV:IPXV_Inst_DispMeasureUnit|DispMeasureUnit]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_IsHistoryLoaded|IsHistoryLoaded]]
−
| Gets current unit of measurement.
+
| [[PXV:IPXV_Inst_Settings|Settings]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ActiveMainView|ActiveMainView]]
 
| [[PXV:IPXV_Inst_Doc|Doc]]
 
| [[PXV:IPXV_Inst_Doc|Doc]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_IsPortable|IsPortable]]
−
| Gets opened document by specified index.
+
| [[PXV:IPXV_Inst_State|State]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_ActivePagesView|ActivePagesView]]
 
| [[PXV:IPXV_Inst_DocCount|DocCount]]
 
| [[PXV:IPXV_Inst_DocCount|DocCount]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_JSCodeSnippets|JSCodeSnippets]]
−
| Gets number of opened documents.
+
| [[PXV:IPXV_Inst_ThreadID|ThreadID]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_AnnotStateModelManager|AnnotStateModelManager]]
 
| [[PXV:IPXV_Inst_EventServer|EventServer]]
 
| [[PXV:IPXV_Inst_EventServer|EventServer]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_LastActiveTool|LastActiveTool]]
−
| Gets global event-server object.
+
| [[PXV:IPXV_Inst_Tool|Tool]]
 
|-
 
|-
 +
| [[PXV:IPXV_Inst_APIVersion|APIVersion]]
 
| [[PXV:IPXV_Inst_EventsRegistry|EventsRegistry]]
 
| [[PXV:IPXV_Inst_EventsRegistry|EventsRegistry]]
−
| style="text-align: center" | R
 
−
| Gets global events registry object.
 
−
|-
 
−
| [[PXV:IPXV_Inst_ExportConverter|ExportConverter]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_ExportConvertersCount|ExportConvertersCount]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_ImportConverter|ImportConverter]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_ImportConvertersCount|ImportConvertersCount]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IPXV_Inst_IsHistoryLoaded|IsHistoryLoaded]]
 
−
| style="text-align: center" | R
 
−
| Gets history loaded flag.
 
−
|-
 
−
| [[PXV:IPXV_Inst_IsPortable|IsPortable]]
 
−
| style="text-align: center" | R
 
−
| Gets portable application flag.
 
−
|-
 
−
| [[PXV:IPXV_Inst_LastActiveTool|LastActiveTool]]
 
−
| style="text-align: center" | R
 
−
| Gets last activated tool.
 
−
|-
 
 
| [[PXV:IPXV_Inst_LastActiveToolID|LastActiveToolID]]
 
| [[PXV:IPXV_Inst_LastActiveToolID|LastActiveToolID]]
−
| style="text-align: center" | R
+
| [[PXV:IPXV_Inst_ToolsCount|ToolsCount]]
−
| Gets identifier of last activated tool.
+
−
|-
+
−
| [[PXV:IPXV_Inst_MainFrm|MainFrm]]
+
−
| style="text-align: center" | R
+
−
| Gets main frame object by specified index.
+
−
|-
+
−
| [[PXV:IPXV_Inst_MainFrmCount|MainFrmCount]]
+
−
| style="text-align: center" | R
+
−
| Gets the number of opened main frames.
+
−
|-
+
−
| [[PXV:IPXV_Inst_ProgressMon|ProgressMon]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets progress actual monitor.
+
−
|-
+
−
| [[PXV:IPXV_Inst_SelectedStamp|SelectedStamp]]
+
−
| style="text-align: center" | R/W
+
−
| .
+
−
|-
+
−
| [[PXV:IPXV_Inst_Settings|Settings]]
+
−
| style="text-align: center" | R
+
−
| Gets object that provides access to all application's settings.
+
−
|-
+
−
| [[PXV:IPXV_Inst_State|State]]
+
−
| style="text-align: center" | R
+
−
| .
+
−
|-
+
−
| [[PXV:IPXV_Inst_ThreadID|ThreadID]]
+
−
| style="text-align: center" | R
+
−
| Returns identifier of main thread.
+
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IPXV_ExportConverter_Convert|IPXV_ExportConverter::Convert]], [[PXV:IPXV_FormatConverter_CreateParams|IPXV_FormatConverter::CreateParams]], [[PXV:IPXV_FormatConverter_ShowPrefsDlg|IPXV_FormatConverter::ShowPrefsDlg]], [[PXV:IPXV_Plugin_Setup|IPXV_Plugin::Setup]], [[PXV:IPXV_TimerHandler_OnTimer|IPXV_TimerHandler::OnTimer]], [[PXV:IPXV_ImportConverter_CheckFormat|IPXV_ImportConverter::CheckFormat]], [[PXV:IPXV_ImportConverter_CheckFormat2|IPXV_ImportConverter::CheckFormat2]], [[PXV:IPXV_ImportConverter_Convert|IPXV_ImportConverter::Convert]], [[PXV:IPXV_OperationsCreator_CreateNewOp|IPXV_OperationsCreator::CreateNewOp]], [[PXV:IPXV_Control_Inst|IPXV_Control::Inst]]

Latest revision as of 03:32, 18 November 2020

PDF Editor Layer > Interfaces > IPXV_Inst Interface


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

Methods

AddDefaultTranslationData FindDocByCoreDoc ID2Str SetLicKey
AddPlugin FindDocByID Init SetMainWindow
AddPluginFromFile FindDocBySrcFile IsCmdBarVisible SetReservedLowMemory
AsyncDo FindDocBySrcFileName IsCmdBarVisible2 SetStdFolder
AsyncDoAndWaitForFinish FindDocBySrcFileName2 LoadHistory SetupMeasureEditFilter
ClearHistory FinishLoadingPlugins LoadUserSettings SetupOperPagesRange
CreateAnnotsList FireAppPrefsChanged LockCmdCustomizationEvent ShowAppPrefsDlg
CreateAttachList FireAppPrefsChanged2 ModifyCoreDoc ShowChooseFontDlg
CreateBookmList FireCmdCustomizationEvent ModifyDoc ShowCmdBar
CreateCIEntry FormatFileSize NewCoreDoc ShowCmdBar2
CreateDocList FormatMeasureValue OpenPlace ShowCreateFileErrDlg
CreateFileNamesProvider FormatNumber PathToName ShowEditActionListDlg
CreateMacroHelper GetAnnotHandler PerformActions ShowMsgBox
CreateMeasureUnitsConvTbl GetCryptKey RefreshOAuthToken ShowMsgBoxEx
CreateNewMainFrm GetCurrentUILang RegisterActionHandler ShowMsgBoxWithOpt
CreateOAuthParams GetDefaultPrinter RegisterDocInfoBarSpan ShowOpenFilesDlg
CreateOp GetDlgParentWindow RegisterDocSelectionHandler ShowRibbonTab
CreateOpenDocParams GetDocFeaturePermission RegisterExportConverter ShowRibbonTab2
CreatePageSizeCtl GetDocFeaturePermission2 RegisterExtension ShowSaveFileDlg
CreatePagesPreviewCtl GetDocSelectionHandler RegisterImportConverter ShowSelectFolderDlg
CreatePlaceProvidersListCtl GetDocViewFromUIObj RegisterOpCreator Shutdown
CreatePlacesListCtl GetExtension RegisterSignatureProvider StartLoadingPlugins
CreateStdBindContext GetFormatConverterIndex RegisterTool StartTimer
CreateStdPresetsButton GetFormatConverterParams RegisterViewCreator StopAllTimers
CreateStdPresetsCallbacks GetHandlerForAction ResetAllDocFeaturesPermissions StopTimer
CreateStdRangeCtl GetLocalStr ResetCmdBar Str2ID
CreateString GetLocalStr2 ResetCmdBar2 Str2Number
DeleteCmdBar GetLocalStrID ResetCmdCustomization SyncronizeAllDocPanesLayouts
DeleteCmdBar2 GetLocalStrID2 RestartTimer SyncronizeCmdCustomization
DoOAuth GetMainViewFromUIObj RevertDoc ThreadSafeCall
EditImage GetMeasureUnitInfo RevertDoc2 ThreadSafeCall2
EditImageFmtParams GetPlaceInfo SaveHistory UnlockCmdCustomizationEvent
EnableRibbonUI GetPluginSettings SaveUserSettings UnregisterDocSelectionHandler
ExecUICmd GetPrinters SetCurrentUILang UnregisterOpCreator
ExecUICmd2 GetStdFolder SetDocFeaturePermission UnregisterViewCreator
ExecuteJS GetTextFromHRes SetDocFeaturePermission2 UpdateProp
ExecuteJSEx GetTool SetFormatConverterParams UpdateProps
ExpandOpenFileFilterAlias GetUILanguages

Properties

ActionHandler AppType ExportConverter MainFrm
ActionHandlersCount CommentStylesManager ExportConvertersCount MainFrmCount
ActiveDoc DefaultProgressMon ImportConverter NavHistory
ActiveDocView DefaultTool ImportConvertersCount ProgressMon
ActiveMainFrm DefaultToolID IsGlobalNavHistory SelectedStamp
ActiveMainFrmWndHandle DispMeasureUnit IsHistoryLoaded Settings
ActiveMainView Doc IsPortable State
ActivePagesView DocCount JSCodeSnippets ThreadID
AnnotStateModelManager EventServer LastActiveTool Tool
APIVersion EventsRegistry LastActiveToolID ToolsCount

See Also

IPXV_ExportConverter::Convert, IPXV_FormatConverter::CreateParams, IPXV_FormatConverter::ShowPrefsDlg, IPXV_Plugin::Setup, IPXV_TimerHandler::OnTimer, IPXV_ImportConverter::CheckFormat, IPXV_ImportConverter::CheckFormat2, IPXV_ImportConverter::Convert, IPXV_OperationsCreator::CreateNewOp, IPXV_Control::Inst

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