PDF-XChange Editor SDK

https://sdkhelp.pdf-xchange.com/
Admin
PDF-XChange Editor SDK is a comprehensive software development kit that enables Windows developers...
Tokens:2,552,183
Snippets:8,477
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### IPXV_Plugin Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Methods for managing plugins, including setup.

```APIDOC
IPXV_Plugin::Setup Method
  - Sets up the plugin.
  - Parameters:
    - config: Configuration parameters.
  - Returns:
    - Boolean indicating success or failure.
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_NavHistory

API documentation for guide selection features.

```APIDOC
IPXV_GuideSelection:
  Description: Handles guide selection.
  Reference: https://sdkhelp.pdf-xchange.com/view/PXV%3AIPXV_GuideSelection
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_DocumentViewsArea

Documentation for the IPXV_GuideSelection interface, related to guide selection within the document.

```APIDOC
IPXV_GuideSelection:
  Description: Interface for managing guide selections, possibly for layout or annotation.
  Details: Refer to the linked documentation for specific methods and properties.
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_MainFrame

Documentation for the IPXV_GuideSelection interface, likely used for managing guide selections or rulers.

```APIDOC
IPXV_GuideSelection:
  Description: Interface for managing guide selections.
  Details: Refer to the linked documentation for specific methods, properties, and usage examples.
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_GuideSelection

Documentation for the IPXV_GuideSelection interface, part of the PDF-XChange SDK, likely handling guide selection functionalities.

```APIDOC
IPXV_GuideSelection:
  Description: Interface for managing guide selections.
  Details: Refer to the SDK documentation for specific methods, properties, and related sections like 'Properties'.
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_OCOrderElementsList

Documentation for the IPXV_GuideSelection interface, likely related to selection mechanisms involving guides or rulers.

```APIDOC
IPXV_GuideSelection:
  Description: Manages selection related to guides.
  Purpose: Allows interaction with guide lines for precise placement or selection.
  Potential Usage: Aligning objects using guides, defining selection boundaries.
```

--------------------------------

### IPXV_Inst Methods and Properties

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Methods and properties for managing the PDF-XChange instance, including settings, setup, showing dialogs, and shutting down.

```APIDOC
IPXV_Inst::Settings Property
  - Accesses the instance's settings.
  - Returns:
    - Settings object.
```

```APIDOC
IPXV_Inst::Setup Method
  - Initializes or sets up the PDF-XChange instance.
  - Parameters:
    - config: Configuration parameters.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::SetupMeasureEditFilter Method
  - Sets up a filter for measure edit operations.
  - Parameters:
    - filter: The measure edit filter.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowChooseFontDlg Method
  - Displays the "Choose Font" dialog.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowCmdBar Method
  - Shows a command bar.
  - Parameters:
    - cmdBarId: Identifier for the command bar.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowCmdBar2 Method
  - Shows a command bar with additional options.
  - Parameters:
    - cmdBarId: Identifier for the command bar.
    - parentWindow: Handle to the parent window.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowCreateFileErrDlg Method
  - Displays an error dialog for file creation failures.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowEditActionListDlg Method
  - Displays a dialog for editing action lists.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowMsgBox Method
  - Displays a standard message box.
  - Parameters:
    - text: The message text.
    - caption: The dialog caption.
    - flags: Message box flags.
  - Returns:
    - Dialog result.
```

```APIDOC
IPXV_Inst::ShowMsgBoxEx Method
  - Displays an extended message box.
  - Parameters:
    - text: The message text.
    - caption: The dialog caption.
    - flags: Message box flags.
    - icon: The icon to display.
  - Returns:
    - Dialog result.
```

```APIDOC
IPXV_Inst::ShowMsgBoxWithOpt Method
  - Displays a message box with options.
  - Parameters:
    - text: The message text.
    - caption: The dialog caption.
    - flags: Message box flags.
    - options: Additional options.
  - Returns:
    - Dialog result.
```

```APIDOC
IPXV_Inst::ShowOpenFilesDlg Method
  - Displays the "Open Files" dialog.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowSaveFileDlg Method
  - Displays the "Save File" dialog.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::ShowSelectFolderDlg Method
  - Displays the "Select Folder" dialog.
  - Returns:
    - Boolean indicating success or failure.
```

```APIDOC
IPXV_Inst::Shutdown Method
  - Shuts down the PDF-XChange instance.
  - Returns:
    - Boolean indicating success or failure.
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_OCRExtAccuracyLevels

Documentation for the IPXV_GuideSelection interface, likely related to user selection of guide lines or rulers.

```APIDOC
IPXV_GuideSelection:
  Description: Interface for guide selection.
  Purpose: Manages the selection and manipulation of guide lines or rulers within the document editing interface.
```

--------------------------------

### SDK Instance Management (Core API SDK)

Source: https://sdkhelp.pdf-xchange.com/view/PXV:CoClasses

For the Core API SDK, PXC_Inst must be initialized once at the start of the program and finalized once when the program exits or the DLL unloads.

```APIDOC
Core API SDK Usage:

- PXC_Inst should be initialized exactly once.
- PXC_Inst should be finalized exactly once when the program exits or the DLL unloads.
```

--------------------------------

### PDF-XChange SDK Components Overview

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_FileNamesProvider

This section lists various interfaces and classes available in the PDF-XChange SDK. Each entry typically links to detailed documentation for methods, properties, and usage examples.

```APIDOC
IPXV_DocHighlightItems
IPXV_DocInfoBar
IPXV_DocInfoBarCallbacks
IPXV_DocList
IPXV_DocSaveEvent
IPXV_DocSelection
IPXV_DocSelectionHandler
IPXV_Document
IPXV_DocumentView
IPXV_DocumentViewsArea
IPXV_DocViewsList
IPXV_EnumFolderCallback
IPXV_EnumViewsCallback
IPXV_ExportConverter
IPXV_FileAttachmentPtr
IPXV_FileNamesProvider
IPXV_FormatConverter
IPXV_FormFieldsEvent
IPXV_FormFieldsList
IPXV_GotoActionEvent
IPXV_GuideSelection
IPXV_ImportConverter
IPXV_InfoWindow
IPXV_InfoWindowGroup
IPXV_Inst
IPXV_InvalidatePagesEvent
IPXV_InvalidatePagesInfo
IPXV_JSCodeSnippet
IPXV_JSCodeSnippetsStorage
IPXV_JSObj
IPXV_JSValue
IPXV_LayersView
IPXV_LinksView
IPXV_LoupeView
IPXV_MacroHelper
IPXV_MainFrame
IPXV_MainView
IPXV_MediaCallback
IPXV_MediaDrawContext
IPXV_NavHistory
IPXV_OCOrderElementsList
IPXV_OcrAccuracyLevels
IPXV_OcrExt
IPXV_OCRExtAccuracyLevels
IPXV_OCRExtension
IPXV_OCRExtLanguages
IPXV_OcrJob
IPXV_OcrLangs
IPXV_OCRRegion
IPXV_OCRRegions
IPXV_OcrRes
IPXV_OCRResult
IPXV_OcrRgn
```

--------------------------------

### Instantiate PXC_Inst ActiveX Object in C++ (Core API via LoadLibrary)

Source: https://sdkhelp.pdf-xchange.com/view/PXV:PXC_Inst

Illustrates an alternative method in C++ to get a pointer to the IPXC_Inst interface by loading the SDK DLL directly. This approach allows using the SDK without a formal COM server installation.

```C++
typedef HRESULT (__cdecl *t_pPXC_GetInstance)(IPXC_Inst** ppInst);

#if defined _M_IX86
#define SDK_LIB_NAME	L"PDFXCoreAPI.x86.DLL"
#else
#define SDK_LIB_NAME	L"PDFXCoreAPI.x64.DLL"
#endif

CComPtr<IPXC_Inst> spPDFInst;
HMODULE hSDKLib = LoadLibrary(SDK_LIB_NAME);
t_pPXC_GetInstance pfn = (t_pPXC_GetInstance)GetProcAddress(hSDKLib, "PXC_GetInstance");
HRESULT hr = pfn(&spPDFInst);
```

--------------------------------

### PDF-XChange SDK Instance Methods

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_Inst_Init

This section provides documentation for various methods available on the PDF-XChange SDK instance. These methods cover functionalities such as managing UI languages, initializing the SDK, manipulating documents, handling user settings, registering custom handlers, and controlling application behavior.

```APIDOC
IPXV_Inst_GetUILanguages:
  Retrieves a list of available UI languages.

IPXV_Inst_ID2Str:
  Converts an internal ID to a string representation.

IPXV_Inst_Init:
  Initializes the PDF-XChange SDK instance.

IPXV_Inst_IsCmdBarVisible:
  Checks if the command bar is currently visible.

IPXV_Inst_IsCmdBarVisible2:
  An alternative method to check command bar visibility.

IPXV_Inst_LoadHistory:
  Loads the document history.

IPXV_Inst_LoadUserSettings:
  Loads user-specific settings.

IPXV_Inst_LockCmdCustomizationEvent:
  Locks or unlocks command customization events.

IPXV_Inst_ModifyCoreDoc:
  Modifies the core document structure.

IPXV_Inst_ModifyDoc:
  Modifies the current document.

IPXV_Inst_NewCoreDoc:
  Creates a new core document.

IPXV_Inst_OpenPlace:
  Opens a specified location or document.

IPXV_Inst_PathToName:
  Converts a file path to a name.

IPXV_Inst_PerformActions:
  Executes a series of predefined actions.

IPXV_Inst_RefreshOAuthToken:
  Refreshes the OAuth token for authentication.

IPXV_Inst_RegisterActionHandler:
  Registers a handler for specific actions.

IPXV_Inst_RegisterDocInfoBarSpan:
  Registers a span for the document info bar.

IPXV_Inst_RegisterDocSelectionHandler:
  Registers a handler for document selection events.

IPXV_Inst_RegisterExportConverter:
  Registers a custom converter for exporting documents.

IPXV_Inst_RegisterExtension:
  Registers a new SDK extension.

IPXV_Inst_RegisterImportConverter:
  Registers a custom converter for importing documents.

IPXV_Inst_RegisterOpCreator:
  Registers a creator for specific operations.

IPXV_Inst_RegisterSignatureProvider:
  Registers a provider for digital signatures.

IPXV_Inst_RegisterTool:
  Registers a new tool within the SDK.

IPXV_Inst_RegisterViewCreator:
  Registers a creator for custom document views.

IPXV_Inst_ResetAllDocFeaturesPermissions:
  Resets all feature permissions for documents.

IPXV_Inst_ResetCmdBar:
  Resets the command bar to its default state.

IPXV_Inst_ResetCmdBar2:
  An alternative method to reset the command bar.

IPXV_Inst_ResetCmdCustomization:
  Resets command customizations.

IPXV_Inst_RestartTimer:
  Restarts an internal timer.

IPXV_Inst_RevertDoc:
  Reverts the current document to a previous state.

IPXV_Inst_RevertDoc2:
  An alternative method to revert the document.

IPXV_Inst_SaveHistory:
  Saves the current document history.

IPXV_Inst_SaveUserSettings:
  Saves the current user settings.

IPXV_Inst_SetCurrentUILang:
  Sets the current UI language.

IPXV_Inst_SetDocFeaturePermission:
  Sets a specific feature permission for a document.

IPXV_Inst_SetDocFeaturePermission2:
  An alternative method to set document feature permissions.

IPXV_Inst_SetFormatConverterParams:
  Sets parameters for a format converter.

IPXV_Inst_SetLicKey:
  Sets the SDK license key.

IPXV_Inst_SetMainWindow:
  Associates the SDK instance with the main application window.

IPXV_Inst_SetReservedLowMemory:
  Configures reserved memory for low-memory conditions.

IPXV_Inst_SetStdFolder:
  Sets a standard folder path for SDK operations.

IPXV_Inst_SetupMeasureEditFilter:
  Sets up a filter for measure editing.

IPXV_Inst_SetupOperPagesRange:
  Configures the range of pages for operations.

IPXV_Inst_ShowAppPrefsDlg:
  Displays the application preferences dialog.

IPXV_Inst_ShowChooseFontDlg:
  Displays the font selection dialog.

IPXV_Inst_ShowCmdBar:
  Shows the command bar.

IPXV_Inst_ShowCmdBar2:
  An alternative method to show the command bar.

IPXV_Inst_ShowCreateFileErrDlg:
  Displays a dialog for file creation errors.
```

--------------------------------

### IPXV_SearchPtr Structure Usage Examples

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_SearchPtr

Illustrates the structure of IPXV_SearchPtr for different search targets within the PDF XChange SDK. Each example shows a sequence of PXV_SearchPtrChunk structures that define the path to the target object.

```APIDOC
IPXV_SearchPtr Structure Usage:

This object holds the path to the object that is being searched for. It is an array of PXV_SearchPtrChunk structures, where each successive structure defines the coordinate of a deeper search level.

WARNING: IPXV_SearchPtr objects cannot be held and used outside of the specific callback methods (IPXV_SearchCallback::OnStartPtr/OnStoptPtr/IPXV_SearchCallback::OnNewEntry) as they can be reused by operations for other contexts.

Examples:

1. Searching Document's Pages:
   {PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Page, <pageIndex>}
   - <docID>: Identifies the document.
   - <pageIndex>: Index of the page.

2. Searching Annotations:
   {PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Page, <pageIndex>}, {PXV_SearchPtrChunk_Annotation, <annotIndexOnThePage>}
   - <annotIndexOnThePage>: Index of the annotation on the page.

3. Searching Bookmarks:
   {PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Bookmark, <PdfObjNumber>}
   - <PdfObjNumber>: PDF Object number of the bookmark.

4. Searching Attachments (with depth):
   {PXV_SearchPtrChunk_Document, <docID>},
     {PXV_SearchPtrChunk_Attachment, <attachmentID>},
       {PXV_SearchPtrChunk_Document, <docID2>},
         {PXV_SearchPtrChunk_Page, <pageIndex>}
   - <attachmentID>: Identifier for the attachment.
   - <docID2>: Document ID within the attachment.
   - <pageIndex>: Page index within the attachment's document.

   {PXV_SearchPtrChunk_Document, <docID>},
     {PXV_SearchPtrChunk_Attachment, <attachmentID>},
       {PXV_SearchPtrChunk_Document, <docID2>},
         {PXV_SearchPtrChunk_Boookmark, <docID2::PdfObjNumber>}
   - <docID2::PdfObjNumber>: PDF Object number of the bookmark within the attachment's document.

   {PXV_SearchPtrChunk_Document, <docID>},
     {PXV_SearchPtrChunk_Attachment, <attachmentID>},
       {PXV_SearchPtrChunk_Document, <docID2>},
         {PXV_SearchPtrChunk_Attachment, <attachmentID2>}
           {PXV_SearchPtrChunk_Document, <docID3>},
             {PXV_SearchPtrChunk_Page, <pageIndex>}
   - Nested attachment structure example.

5. Searching Document's Info Fields:
   {PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_DocInfo, <strID>}
   - <strID>: Identifier for the string/tag of the info field.

Special Cases:
- When PXV_SearchPtrChunk.nValue is -1, it indicates the start/end of a search stage:
  - {PXV_SearchPtrChunk_Bookmark, -1}: Operation begins/ends searching through bookmarks.
  - {PXV_SearchPtrChunk_Page, -1}: Operation begins/ends searching through pages.
  - {PXV_SearchPtrChunk_DocInfo, -1}: Operation begins/ends searching through document's info fields.
```

--------------------------------

### Get IPXC_Inst via PXC_GetInstance (Core API SDK)

Source: https://sdkhelp.pdf-xchange.com/view/PXV:PXC

Shows how to get an IPXC_Inst object by calling the exported PXC_GetInstance function from the SDK's DLL when not using registration. This involves loading the DLL and resolving the function address.

```C++
typedef HRESULT (WINAPI *fnPXC_GetInstance)(IPXC_Inst** ppInst);

HRESULT fGetInst(CComPtr<IPXC_Inst>& inst)
{
  inst = nullptr;
  HMODULE hSDKInst = LoadLibrary(_T("PDFXCoreAPI.x64.dll"));
  if (hSDKInst == nullptr)
    return E_FAIL;
  fnPXC_GetInstance pfn = (fnPXC_GetInstance)GetProcAddress(hSDKInst, "PXC_GetInstance");
  if (pfn == nullptr)
    return E_FAIL;
  HRESULT hr = pfn(&inst);
  return hr;
}
```

--------------------------------

### IPXV_Inst Create Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Documentation for 'Create' methods within the IPXV_Inst class, used for initializing and configuring SDK components.

```APIDOC
IPXV_Inst::CreateAnnotsList Method
  - Description: Creates a list for annotations.
  - Related: IPXV_Inst

IPXV_Inst::CreateBookmList Method
  - Description: Creates a list for bookmarks.
  - Related: IPXV_Inst

IPXV_Inst::CreateMeasureUnitsConvTbl Method
  - Description: Creates a table for converting measurement units.
  - Related: IPXV_Inst

IPXV_Inst::CreateNewMainFrm Method
  - Description: Creates a new main frame window.
  - Related: IPXV_Inst

IPXV_Inst::CreateOp Method
  - Description: Creates an operation object.
  - Related: IPXV_Inst

IPXV_Inst::CreateOpenDocParams Method
  - Description: Creates parameters for opening a document.
  - Related: IPXV_Inst

IPXV_Inst::CreatePageSizeCtl Method
  - Description: Creates a control for managing page sizes.
  - Related: IPXV_Inst

IPXV_Inst::CreateStdBindContext Method
  - Description: Creates a standard binding context.
  - Related: IPXV_Inst

IPXV_Inst::CreateStdPresetsButton Method
  - Description: Creates a button for standard presets.
  - Related: IPXV_Inst

IPXV_Inst::CreateStdPresetsCallbacks Method
  - Description: Creates callbacks for standard presets.
  - Related: IPXV_Inst

IPXV_Inst::CreateStdRangeCtl Method
  - Description: Creates a control for managing ranges.
  - Related: IPXV_Inst

IPXV_Inst::CreateString Method
  - Description: Creates a string object.
  - Related: IPXV_Inst
```

--------------------------------

### IPXV_PresetsListCallbacks API

Source: https://sdkhelp.pdf-xchange.com/view/IndexTypeLibrary

Documentation for the IPXV_PresetsListCallbacks interface, managing callbacks for a list of presets.

```APIDOC
IPXV_PresetsListCallbacks:
  Description: Interface for callbacks associated with a list of presets.
```

--------------------------------

### IPXV_DocumentView Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Method for getting the placement of a document view.

```APIDOC
IPXV_DocumentView::GetPlacement Method
  - Retrieves the placement information for the document view.
```

--------------------------------

### Instantiate PXV_Inst ActiveX Object

Source: https://sdkhelp.pdf-xchange.com/view/PXV:PXV_Inst

Demonstrates how to instantiate the PXV_Inst ActiveX Object using standard COM methods in C#, VB6, and C++. These examples show the typical patterns for creating an instance of the SDK's main object.

```C#
AxPDFXEdit.AxPXV_Inst pdfInst = new AxPDFXEdit.AxPXV_Inst();
```

```VB6
Dim pdfInst As PDFXEdit.PXV_Inst
...
Set pdfInst = New PDFXEdit.PXV_Inst
```

```C++
CComPtr<IPXV_Inst> spPDFInst;
HRESULT hr = CoCreateInstance(__uuidof(PXV_Inst), nullptr, CLSCTX_INPROC_SERVER, __uuidof(IPXV_Inst), (void**)&spPDFInst);
```

--------------------------------

### IPXV_PresetsButton API

Source: https://sdkhelp.pdf-xchange.com/view/IndexTypeLibrary

Documentation for the IPXV_PresetsButton component, likely a UI element for managing presets.

```APIDOC
IPXV_PresetsButton:
  Description: UI button component for preset management.
```

--------------------------------

### IPXV_PresetsIoCallbacks API

Source: https://sdkhelp.pdf-xchange.com/view/IndexTypeLibrary

Documentation for the IPXV_PresetsIoCallbacks interface, handling input/output operations for presets.

```APIDOC
IPXV_PresetsIoCallbacks:
  Description: Interface for handling input/output operations related to presets.
```

--------------------------------

### IPXC_SecurityPolicy Properties

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXC_SecurityPolicy

This section lists the properties accessible through the IPXC_SecurityPolicy interface. It includes a property to get the count of information tags.

```APIDOC
IPXC_SecurityPolicy:
  InfoTagsCount
    Description: Gets the number of information tags available for the security policy.
```

--------------------------------

### IUIX_Ruler

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IUIX_TabStopFormat

Interface for a ruler UI element in the PDF-XChange SDK. Used for displaying measurement scales or guides.

```APIDOC
IUIX_Ruler:
  Description: Interface for a ruler UI element.
  Purpose: Displays measurement scales and guides for layout or positioning.
  Usage: Integrate to provide visual aids for precise placement of elements.
```

--------------------------------

### PDF-XChange SDK Interfaces

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_Inst_Init

List of interfaces provided by the PDF-XChange SDK for accessing various components and functionalities.

```APIDOC
IPXV_InvalidatePagesEvent
  - Interface related to invalidating page data.

IPXV_InvalidatePagesInfo
  - Structure or interface for information about invalidated pages.

IPXV_JSCodeSnippet
  - Interface for JavaScript code snippets.

IPXV_JSCodeSnippetsStorage
  - Interface for managing storage of JavaScript code snippets.

IPXV_JSObj
  - Interface representing a JavaScript object.

IPXV_JSValue
  - Interface representing a JavaScript value.

IPXV_LayersView
  - Interface for viewing and managing layers.

IPXV_LinksView
  - Interface for viewing and managing hyperlinks.

IPXV_LoupeView
  - Interface for a loupe or zoom view component.

IPXV_MacroHelper
  - Helper interface for macro operations.

IPXV_MainFrame
  - Interface representing the main application frame.

IPXV_MainView
  - Interface representing the main document view.

IPXV_MediaCallback
  - Interface for media-related callback functions.

IPXV_MediaDrawContext
  - Interface for the drawing context used in media rendering.

IPXV_NavHistory
  - Interface for managing navigation history.

IPXV_OCOrderElementsList
  - Interface for an ordered list of OCR elements.

IPXV_OcrAccuracyLevels
  - Interface defining accuracy levels for OCR.

IPXV_OcrExt
  - Extended interface for OCR functionalities.

IPXV_OCRExtAccuracyLevels
  - Interface for extended OCR accuracy levels.

IPXV_OCRExtension
  - Interface for OCR extensions.

IPXV_OCRExtLanguages
  - Interface for managing OCR extension languages.

IPXV_OcrJob
  - Interface representing an OCR job.

IPXV_OcrLangs
  - Interface for managing OCR languages.

IPXV_OCRRegion
  - Interface defining an OCR processing region.
```

--------------------------------

### IUIX_ListGetSelCallback

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IUIX_TabStopFormat

Callback interface for retrieving the selected item(s) from a list in the PDF-XChange SDK. Used to get information about the current selection.

```APIDOC
IUIX_ListGetSelCallback:
  Description: Callback interface for retrieving list selection.
  Purpose: Provides a mechanism to get the currently selected item(s) from a list.
  Usage: Implement to define how selection data is accessed or processed.
```

--------------------------------

### IPXV_Control and IPXV_Inst Properties and Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Documentation for properties and methods related to the IPXV_Control and IPXV_Inst interfaces, focusing on instance access and command bar visibility.

```APIDOC
IPXV_Control::Inst Property
  Description: Provides access to the IPXV_Inst instance.
  Related: IPXV_Inst::IsCmdBarVisible, IPXV_Inst::IsCmdBarVisible2
```

```APIDOC
IPXV_Inst::IsCmdBarVisible Method
  Description: Checks if the command bar is currently visible.
  Related: IPXV_Inst::IsCmdBarVisible2, IPXV_Control::Inst
```

```APIDOC
IPXV_Inst::IsCmdBarVisible2 Method
  Description: An alternative method to check command bar visibility.
  Related: IPXV_Inst::IsCmdBarVisible, IPXV_Control::Inst
```

--------------------------------

### IPXC_OCContext and IPXC_AnnotsVisibilityCallback

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXC_Annotation

Functions related to annotation appearance styles and visibility checks, including getting application-specific styles and determining if an annotation is visible.

```APIDOC
IPXC_OCContext::GetAnnotAppStyle(int nAnnotID)
  - Retrieves the application-specific style for an annotation.

IPXC_OCContext::IsAnnotVisible(int nAnnotID)
  - Checks if an annotation is currently visible.

IPXC_AnnotsVisibilityCallback::GetAnnotVisibility(int nAnnotID)
  - Callback function to determine the visibility of an annotation.
```

--------------------------------

### Initialize IPXV_Inst Instance

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_Inst_Init

This method initializes the main object instance of the PDF XChange SDK. It must be called first, before any other method, except for specific folder and string related functions. It accepts context, license key, user settings source, history source, history thumbnails source, flags, and reserved parameters.

```APIDOC
IPXV_Inst::Init Method

Description:
Initializes the main object instance and must be called first, before of calling any other method (excepting IPXV_Inst::SetStdFolder, IPXV_Inst::GetStdFolder, IPXV_Inst::CreateString).

Syntax:
HRESULT Init([in, defaultvalue(NULL)]  IUnknown*  pCtx,
             [in, defaultvalue("")]    BSTR       pLicKey,
             [in, defaultvalue(NULL)]  IUnknown*  pUserSettingsSrc,
             [in, defaultvalue(NULL)]  IUnknown*  pHistorySrc,
             [in, defaultvalue(NULL)]  IUnknown*  pHistoryThumbsSrc,
             [in, defaultvalue(0)]     LONG       nFlags,
             [in, defaultvalue(NULL)]  IUnknown*  pReserved);

Parameters:
pCtx:
  [in, optional] A pointer to IUnknown interface of context-object. This parameter is optional and can be NULL. Reserved for the future.

pLicKey:
  [in, optional] A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.

pUserSettingsSrc:
  [in, optional] A pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of all user's preferences. This parameter is optional and can be NULL. Also via IString you may specify path to local file or path to custom location in system's registry in format for example:
HKEY_CURRENT_USER\Software\MyApp\PDFEditorSettings
HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSettings
The list of supported registry-root names: HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM.

pHistorySrc:
  [in, optional] Pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of documents opening history. This parameter is optional and can be NULL. Also via IString you may specify path to local file or path to custom location in system's registry (see description for pUserSettingsSrc).

pHistoryThumbsSrc:
  [in, optional] Pointer to IAFS_Name/IAFS_File/IString/IStream object that specifies the source of thumbnails-cache for documents opening history. This parameter is optional and can be NULL.

nFlags:
  [in, optional] The reserved parameter. Pass 0 there.

pReserved:
  [in, optional] The reserved parameter. Pass NULL there.

Return Value:
Returns S_OK if operation was successful or error code in other cases.

See Also:
IPXV_Inst
```

--------------------------------

### IPXV_GuideSelection API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_OcrLangs

Manages selection operations related to guides or rulers within the document view. Used for precise positioning and alignment.

```APIDOC
IPXV_GuideSelection:
  // Interface for handling guide-based selections.
  // Assists in precise element placement and alignment.
```

--------------------------------

### IPXV_Inst Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Core instance methods for managing extensions, local strings, measure units, plugins, printers, and tools.

```APIDOC
IPXV_Inst::GetExtension Method
  - Retrieves an extension.

IPXV_Inst::GetLocalStr Method
  - Retrieves a local string by ID.

IPXV_Inst::GetLocalStr2 Method
  - Retrieves a local string by ID (alternative).

IPXV_Inst::GetLocalStrID Method
  - Retrieves the ID for a local string.

IPXV_Inst::GetLocalStrID2 Method
  - Retrieves the ID for a local string (alternative).

IPXV_Inst::GetMeasureUnitInfo Method
  - Retrieves information about the current measure unit.

IPXV_Inst::GetPluginSettings Method
  - Retrieves settings for a plugin.

IPXV_Inst::GetPrinters Method
  - Retrieves a list of available printers.

IPXV_Inst::GetStdFolder Method
  - Retrieves a standard folder path.

IPXV_Inst::GetTextFromHRes Method
  - Retrieves text from a resource handle.

IPXV_Inst::GetTool Method
  - Retrieves a specific tool.

IPXV_Inst::GetUILanguages Method
  - Retrieves a list of supported UI languages.
```

--------------------------------

### IPXV_Inst Properties and Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Documentation for properties and methods of the IPXV_Inst interface, covering active documents, views, plugins, and API version.

```APIDOC
IPXV_Inst::ActiveDoc Property
  - Description: Retrieves the currently active document.
  - Related: IPXV_Inst::ActiveDocView Property, IPXV_Inst::ActiveMainFrm Property
```

```APIDOC
IPXV_Inst::ActiveDocView Property
  - Description: Gets the currently active document view.
  - Related: IPXV_Inst::ActiveDoc Property, IPXV_Inst::ActiveMainView Property
```

```APIDOC
IPXV_Inst::ActiveMainFrm Property
  - Description: Returns the main frame window that is currently active.
  - Related: IPXV_Inst::ActiveDocView Property, IPXV_Inst::ActiveMainView Property
```

```APIDOC
IPXV_Inst::ActiveMainView Property
  - Description: Gets the main view associated with the active document.
  - Related: IPXV_Inst::ActiveDocView Property, IPXV_Inst::ActiveMainFrm Property
```

```APIDOC
IPXV_Inst::AddDefaultTranslationData Method
  - Description: Adds default translation data to the instance.
  - Parameters: None specified.
  - Returns: Boolean indicating success.
```

```APIDOC
IPXV_Inst::AddPlugin Method
  - Description: Adds a plugin to the PDF-XChange instance.
  - Parameters: Pointer to the plugin object.
  - Returns: Boolean indicating success.
```

```APIDOC
IPXV_Inst::AddPluginFromFile Method
  - Description: Loads and adds a plugin from a specified file.
  - Parameters: File path to the plugin.
  - Returns: Boolean indicating success.
```

```APIDOC
IPXV_Inst::APIVersion Property
  - Description: Retrieves the version of the PDF-XChange SDK API.
  - Related: IPXC_Inst::APIVersion Property
```

--------------------------------

### Content Creator Functions

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXS_PDFVariant

Provides methods for creating and managing content within PDF documents, such as adding places or starting containers.

```APIDOC
IPXC_ContentCreator::AddPlace(place):
  Adds a place to the content creator.
  Parameters:
    place: The place object to add.

IPXC_ContentCreator::StartContainer():
  Starts a new container for content creation.
```

--------------------------------

### IUIX_ThemeClassPartState

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IUIX_TabStopFormat

Interface defining the styling for a particular state of a theme class part in the PDF-XChange SDK. For example, 'hover', 'pressed', 'disabled'.

```APIDOC
IUIX_ThemeClassPartState:
  Description: Interface for a theme class part state.
  Purpose: Specifies the visual appearance of a UI element part in a
```

--------------------------------

### IUIX_Cmd Properties and Methods

Source: https://sdkhelp.pdf-xchange.com/view/Special:NavigationTreeLabels

Documentation for properties and methods of the IUIX_Cmd interface, including Alias and shortcut management.

```APIDOC
IUIX_Cmd::Alias Property
  - Description: Gets or sets an alias for the command.
```

```APIDOC
IUIX_Cmd::AddShortcut Method
  - Description: Adds a keyboard shortcut to the command.
  - Parameters: Shortcut key combination.
```

```APIDOC
IUIX_Cmd::AddShortcut2 Method
  - Description: Adds an alternative keyboard shortcut to the command.
  - Parameters: Shortcut key combination.
```

--------------------------------

### IRangeHelper Methods

Source: https://sdkhelp.pdf-xchange.com/view/PXV:PXC_Rect

Provides methods for managing custom rectangle definitions within the PDF-XChange SDK. These include getting, setting, and accessing the current rectangle.

```APIDOC
IRangeHelper::GetCustomRect
  - Retrieves the current custom rectangle.

IRangeHelper::SetCustomRect
  - Sets a custom rectangle.

IRangeHelper::CurrentRect
  - Accesses the current rectangle.
```

--------------------------------

### IPXC_3DNode Methods

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXC_3DNode

Provides access to methods for interacting with 3D nodes in the PDF XChange SDK. Includes functions for getting and setting render modes.

```APIDOC
IPXC_3DNode Methods:

GetRenderMode()
  - Retrieves the current render mode of the 3D node.

SetRenderMode(mode)
  - Sets the render mode for the 3D node.
  - Parameters:
    - mode: The desired render mode.
```

--------------------------------

### IPXV_Inst::GetPluginSettings Method

Source: https://sdkhelp.pdf-xchange.com/view/Special:PopularPages

Documentation for the GetPluginSettings method within the IPXV_Inst class. This method is used to retrieve configuration settings for plugins.

```APIDOC
IPXV_Inst::GetPluginSettings
  Description: Retrieves the settings for a specific plugin.
  Parameters:
    - pluginName: The name or identifier of the plugin.
  Returns: A structure or object containing the plugin's settings.
  Usage: Accessing and modifying plugin configurations.
```

--------------------------------

### IUIX_ListGetSelCallback API

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IUIX_ParaFormat

Documentation for the IUIX_ListGetSelCallback interface, a specific callback for retrieving selected items from a list. This interface is used to get information about the currently selected item(s).

```APIDOC
IUIX_ListGetSelCallback:
  Description: Callback interface for retrieving list selection.
  Purpose: Provides a mechanism to get the currently selected item(s) from a list.
  Usage: Implement to define how selection information is accessed or processed.
```

--------------------------------

### IPXC_Inst Initialization and Document Handling

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXC_Inst_Init

Methods for initializing the PDF-XChange SDK instance and managing PDF documents, including creation, opening from various sources, and finalization.

```APIDOC
IPXC_Inst:
  Init()
    Initializes the PDF-XChange SDK instance.

  NewDocument()
    Creates a new, empty PDF document.

  NewDocumentEx(pDocParams)
    Creates a new PDF document with specified parameters.
    - pDocParams: Pointer to a structure containing document creation parameters.

  OpenDocumentFrom(pSource)
    Opens an existing PDF document from a specified source.
    - pSource: Pointer to the document source.

  OpenDocumentFromFile(filePath)
    Opens an existing PDF document from a file path.
    - filePath: The path to the PDF file.

  Finalize()
    Finalizes the PDF document and releases resources.
```

--------------------------------

### IPXV_ActionHandler Class Methods

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_Document

Handles actions and their associated properties. Methods include filling dictionaries, getting descriptions, and showing properties.

```APIDOC
IPXV_ActionHandler::FillDictionary
  - Populates a dictionary with action-related data.

IPXV_ActionHandler::GetDescription
  - Retrieves a textual description of the action.

IPXV_ActionHandler::ShowProperties
  - Displays the properties associated with an action.
```

--------------------------------

### Get Editor SDK Instance

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXV_Control_Inst

Retrieves a pointer to the main Editor SDK object (IPXV_Inst) via the get_Inst method. This is a COM-style interface method.

```APIDOC
HRESULT get_Inst([out, retval]  IPXV_Inst**  pInst);

Parameters:
  pInst: [out, retval] Pointer to an IPXV_Inst interface pointer that receives the instance of the main Editor SDK object.

Returns:
  HRESULT: An HRESULT value indicating success or failure. Typically, S_OK for success.
```

--------------------------------

### IPXC_Inst::Init Method

Source: https://sdkhelp.pdf-xchange.com/view/PXV:IPXC_Inst_Init

Initializes the IPXC_Inst interface with a license key.

```APIDOC
IPXC_Inst::Init Method

Initializes the IPXC_Inst interface.

Syntax:
  HRESULT Init([in] LPWSTR sKey);

Parameters:
  sKey: [in] Value of LPWSTR. The license key.

Return Value:
  Returns S_OK if operation was successful or error code in other cases.

See Also:
  IPXC_Inst
```
Tokens:
Raw