PDF Toolbox
Loading...
Searching...
No Matches
Macros | Functions
PdfTools_Toolbox_PtxPdfNav.h File Reference
#include "PdfTools_Toolbox_Types.h"
#include "PdfTools_Toolbox_PtxSys.h"

Go to the source code of this file.

Macros

#define PDFTOOLS_TOOLBOX_CALL
 
#define PtxPdfNav_OutlineItem_Create   PtxPdfNav_OutlineItem_CreateA
 
#define PtxPdfNav_OutlineItem_GetTitle   PtxPdfNav_OutlineItem_GetTitleA
 
#define PtxPdfNav_OutlineItem_SetTitle   PtxPdfNav_OutlineItem_SetTitleA
 
#define PtxPdfNav_NamedDestination_Create   PtxPdfNav_NamedDestination_CreateA
 
#define PtxPdfNav_NamedDestination_GetName   PtxPdfNav_NamedDestination_GetNameA
 
#define PtxPdfNav_WebLink_Create   PtxPdfNav_WebLink_CreateA
 
#define PtxPdfNav_WebLink_CreateFromQuadrilaterals   PtxPdfNav_WebLink_CreateFromQuadrilateralsA
 
#define PtxPdfNav_WebLink_GetUri   PtxPdfNav_WebLink_GetUriA
 
#define PtxPdfNav_WebLink_SetUri   PtxPdfNav_WebLink_SetUriA
 

Functions

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfNav_ViewerSettings *pViewerSettings)
 Copy viewer settings The newly created viewer settings are associated with the target document, but not yet used as the document's viewer settings.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetPageDisplay (TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_PageDisplay *pPageDisplay)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetPageDisplay (TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_PageDisplay *pPageDisplay)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetActivePane (TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_ViewerNavigationPane *pActivePane)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetActivePane (TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_ViewerNavigationPane *pActivePane)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetFullScreen (TPtxPdfNav_ViewerSettings *pViewerSettings)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetFullScreen (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bFullScreen)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideToolbar (TPtxPdfNav_ViewerSettings *pViewerSettings)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideToolbar (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideToolbar)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideMenubar (TPtxPdfNav_ViewerSettings *pViewerSettings)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideMenubar (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideMenubar)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle (TPtxPdfNav_ViewerSettings *pViewerSettings)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bDisplayDocumentTitle)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateA (TPtxPdf_Document *pTargetDocument, const char *szTitle, TPtxPdfNav_Destination *pDestination)
 Create a new outline item (bookmark). The returned outline item is not yet part of the outline item tree, but it is associated with the given target document. It can be inserted at any position in the tree.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateW (TPtxPdf_Document *pTargetDocument, const WCHAR *szTitle, TPtxPdfNav_Destination *pDestination)
 Create a new outline item (bookmark). The returned outline item is not yet part of the outline item tree, but it is associated with the given target document. It can be inserted at any position in the tree.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_OutlineCopyOptions *pOptions)
 Copy an outline item Copy an outline item object including all descendants from an input document to the given pTargetDocument. The returned object is associated with the given target document but not yet part of it.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleA (TPtxPdfNav_OutlineItem *pOutlineItem, char *pBuffer, size_t nBufferSize)
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleW (TPtxPdfNav_OutlineItem *pOutlineItem, WCHAR *pBuffer, size_t nBufferSize)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleA (TPtxPdfNav_OutlineItem *pOutlineItem, const char *szTitle)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleW (TPtxPdfNav_OutlineItem *pOutlineItem, const WCHAR *szTitle)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetBold (TPtxPdfNav_OutlineItem *pOutlineItem)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetBold (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bBold)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetItalic (TPtxPdfNav_OutlineItem *pOutlineItem)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetItalic (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bItalic)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetDestination (TPtxPdfNav_OutlineItem *pOutlineItem)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetDestination (TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_Destination *pDestination)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_IsOpen (TPtxPdfNav_OutlineItem *pOutlineItem)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetIsOpen (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bIsOpen)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetChildren (TPtxPdfNav_OutlineItem *pOutlineItem)
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_GetCount (TPtxPdfNav_OutlineItemList *pOutlineItemList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Get (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Add (TPtxPdfNav_OutlineItemList *pOutlineItemList, TPtxPdfNav_OutlineItem *pOutlineItem)
 Add an element to the end of the list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Clear (TPtxPdfNav_OutlineItemList *pOutlineItemList)
 Clear list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Remove (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
 Remove certain element from list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Set (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex, TPtxPdfNav_OutlineItem *pValue)
 Update certain element in list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DirectDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Destination_GetTarget (TPtxPdfNav_Destination *pDestination)
 The target destination For direct destinations, this is just the destination itself.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DestinationType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Destination_GetType (TPtxPdfNav_Destination *pDestination)
 Get actual derived type of base type TPtxPdfNav_Destination.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateA (TPtxPdf_Document *pTargetDocument, const char *szName, TPtxPdfNav_DirectDestination *pTarget)
 Create a named destination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateW (TPtxPdf_Document *pTargetDocument, const WCHAR *szName, TPtxPdfNav_DirectDestination *pTarget)
 Create a named destination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameA (TPtxPdfNav_NamedDestination *pNamedDestination, char *pBuffer, size_t nBufferSize)
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameW (TPtxPdfNav_NamedDestination *pNamedDestination, WCHAR *pBuffer, size_t nBufferSize)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_DirectDestination_GetPage (TPtxPdfNav_DirectDestination *pDirectDestination)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DirectDestinationType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_DirectDestination_GetType (TPtxPdfNav_DirectDestination *pDirectDestination)
 Get actual derived type of base type TPtxPdfNav_DirectDestination.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_Create (TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, const double *pLeft, const double *pTop, const double *pZoom)
 Create a new LocationZoomDestination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetLeft (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pLeft)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetTop (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pTop)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetZoom (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pZoom)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_Create (TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
 Create a new FitPageDestination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_GetFitActualContent (TPtxPdfNav_FitPageDestination *pFitPageDestination)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_Create (TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
 Create a new FitWidthDestination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_GetFitActualContent (TPtxPdfNav_FitWidthDestination *pFitWidthDestination)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_Create (TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
 Create a new FitHeightDestination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_GetFitActualContent (TPtxPdfNav_FitHeightDestination *pFitHeightDestination)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_Create (TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, const TPtxGeomReal_Rectangle *pRectangle)
 Create a new FitRectangleDestination The returned object is not yet used on any page, but it is associated with the given target document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_GetRectangle (TPtxPdfNav_FitRectangleDestination *pFitRectangleDestination, TPtxGeomReal_Rectangle *pRectangle)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfNav_Link *pLink)
 Copy a link from an input document to a output document.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetActiveArea (TPtxPdfNav_Link *pLink)
 The link area The link is activated when a mouse click falls within the area defined by this list of TPtxGeomReal_Quadrilaterals.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetBoundingBox (TPtxPdfNav_Link *pLink, TPtxGeomReal_Rectangle *pBoundingBox)
 The location on the page.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetHidden (TPtxPdfNav_Link *pLink)
 The link's visibility If TRUE then the link is present, but is invisible and not available for user interaction. Depending on the PtxPdfNav_Link_GetNoPrint property it will, however, still be visible when printing.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetNoPrint (TPtxPdfNav_Link *pLink)
 The link's visibility when printing If TRUE then the link is not present in a print output of the document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_SetBorderStyle (TPtxPdfNav_Link *pLink, TPtxPdfContent_Stroke *pBorderStyle)
 The link's border This property defines if and how a rectangular border is drawn for the link.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LinkType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetType (TPtxPdfNav_Link *pLink)
 Get actual derived type of base type TPtxPdfNav_Link.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_GetCount (TPtxPdfNav_LinkList *pLinkList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Get (TPtxPdfNav_LinkList *pLinkList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Add (TPtxPdfNav_LinkList *pLinkList, TPtxPdfNav_Link *pLink)
 Add an element to the end of the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfNav_Destination *pTarget)
 Create a document-internal link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, TPtxPdfNav_Destination *pTarget)
 Create a document-internal link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_GetDestination (TPtxPdfNav_InternalLink *pInternalLink)
 The link target.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateA (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const char *szUri)
 Create an external link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateW (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const WCHAR *szUri)
 Create an external link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsA (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, const char *szUri)
 Create an external link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsW (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, const WCHAR *szUri)
 Create an external link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriA (TPtxPdfNav_WebLink *pWebLink, char *pBuffer, size_t nBufferSize)
 The link target.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriW (TPtxPdfNav_WebLink *pWebLink, WCHAR *pBuffer, size_t nBufferSize)
 The link target.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriA (TPtxPdfNav_WebLink *pWebLink, const char *szUri)
 The link target.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriW (TPtxPdfNav_WebLink *pWebLink, const WCHAR *szUri)
 The link target.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdf_FileReference *pFileReference)
 Create a link to an embedded PDF document The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, TPtxPdf_FileReference *pFileReference)
 Create a link to an embedded PDF document with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_GetNewWindow (TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, BOOL *pNewWindow)
 The opening behavior This defines the viewer's behavior when opening the target PDF document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_SetNewWindow (TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, const BOOL *pNewWindow)
 The opening behavior This defines the viewer's behavior when opening the target PDF document.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineCopyOptions *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_New (void)
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
 Copy the logical structure and tagging information.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, BOOL bCopyLogicalStructure)
 Copy the logical structure and tagging information.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetNamedDestinations (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
 Copy strategy for named destinations.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetNamedDestinations (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
 Copy strategy for named destinations.
 

Macro Definition Documentation

◆ PDFTOOLS_TOOLBOX_CALL

#define PDFTOOLS_TOOLBOX_CALL

◆ PtxPdfNav_NamedDestination_Create

#define PtxPdfNav_NamedDestination_Create   PtxPdfNav_NamedDestination_CreateA

◆ PtxPdfNav_NamedDestination_GetName

#define PtxPdfNav_NamedDestination_GetName   PtxPdfNav_NamedDestination_GetNameA

◆ PtxPdfNav_OutlineItem_Create

#define PtxPdfNav_OutlineItem_Create   PtxPdfNav_OutlineItem_CreateA

◆ PtxPdfNav_OutlineItem_GetTitle

#define PtxPdfNav_OutlineItem_GetTitle   PtxPdfNav_OutlineItem_GetTitleA

◆ PtxPdfNav_OutlineItem_SetTitle

#define PtxPdfNav_OutlineItem_SetTitle   PtxPdfNav_OutlineItem_SetTitleA

◆ PtxPdfNav_WebLink_Create

#define PtxPdfNav_WebLink_Create   PtxPdfNav_WebLink_CreateA

◆ PtxPdfNav_WebLink_CreateFromQuadrilaterals

#define PtxPdfNav_WebLink_CreateFromQuadrilaterals   PtxPdfNav_WebLink_CreateFromQuadrilateralsA

◆ PtxPdfNav_WebLink_GetUri

#define PtxPdfNav_WebLink_GetUri   PtxPdfNav_WebLink_GetUriA

◆ PtxPdfNav_WebLink_SetUri

#define PtxPdfNav_WebLink_SetUri   PtxPdfNav_WebLink_SetUriA

Function Documentation

◆ PtxPdfNav_Destination_GetTarget()

The target destination For direct destinations, this is just the destination itself.

Parameters
[in,out]pDestinationActs as a handle to the native object of type TPtxPdfNav_Destination.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Destination_GetType()

Get actual derived type of base type TPtxPdfNav_Destination.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters
[in,out]pDestinationActs as a handle to a native object.
Returns
The item of the enumeration TPtxPdfNav_DestinationType that refers to the actual derived type. 0 in case of an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_DirectDestination_GetPage()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_DirectDestination_GetPage ( TPtxPdfNav_DirectDestination * pDirectDestination)

The page in the document that this destination is pointing to.

Parameters
[in,out]pDirectDestinationActs as a handle to the native object of type TPtxPdfNav_DirectDestination.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_DirectDestination_GetType()

Get actual derived type of base type TPtxPdfNav_DirectDestination.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters
[in,out]pDirectDestinationActs as a handle to a native object.
Returns
The item of the enumeration TPtxPdfNav_DirectDestinationType that refers to the actual derived type. 0 in case of an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_EmbeddedPdfLink_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_Create ( TPtxPdf_Document * pTargetDocument,
const TPtxGeomReal_Rectangle * pBoundingBox,
TPtxPdf_FileReference * pFileReference )

Create a link to an embedded PDF document The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in]pBoundingBoxThe location on the page
[in,out]pFileReferenceThe embedded PDF file
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_EmbeddedPdfLink_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_CreateFromQuadrilaterals ( TPtxPdf_Document * pTargetDocument,
TPtxGeomReal_QuadrilateralList * pActiveArea,
TPtxPdf_FileReference * pFileReference )

Create a link to an embedded PDF document with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in,out]pActiveAreaThe active link area on the page.
[in,out]pFileReferenceThe embedded PDF file
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_EmbeddedPdfLink_GetNewWindow()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_GetNewWindow ( TPtxPdfNav_EmbeddedPdfLink * pEmbeddedPdfLink,
BOOL * pNewWindow )

The opening behavior This defines the viewer's behavior when opening the target PDF document.

  • NULL: The viewer uses its default behavior.
  • TRUE: Open the document in an additional window.
  • FALSE: Replace the parent document with the embedded document.
Parameters
[in,out]pEmbeddedPdfLinkActs as a handle to the native object of type TPtxPdfNav_EmbeddedPdfLink.
[out]pNewWindowRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_EmbeddedPdfLink_SetNewWindow()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_SetNewWindow ( TPtxPdfNav_EmbeddedPdfLink * pEmbeddedPdfLink,
const BOOL * pNewWindow )

The opening behavior This defines the viewer's behavior when opening the target PDF document.

  • NULL: The viewer uses its default behavior.
  • TRUE: Open the document in an additional window.
  • FALSE: Replace the parent document with the embedded document.
Parameters
[in,out]pEmbeddedPdfLinkActs as a handle to the native object of type TPtxPdfNav_EmbeddedPdfLink.
[in]pNewWindowSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitHeightDestination_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_Create ( TPtxPdf_Document * pTargetDocument,
TPtxPdf_Page * pPage,
BOOL bFitActualContent )

Create a new FitHeightDestination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in,out]pPageThe page in the document that this destination is pointing to.
[in]bFitActualContentIf TRUE, the viewport is fitted to the actual content of the page, instead of the size of the page. See property PtxPdfNav_FitHeightDestination_GetFitActualContent for more information.
Returns
The newly created destination object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitHeightDestination_GetFitActualContent()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_GetFitActualContent ( TPtxPdfNav_FitHeightDestination * pFitHeightDestination)

If TRUE, the viewport is fitted to the width of the actual content of the page, instead of the width of the page.

Note: Many PDF viewers simply ignore this property and always treat it as FALSE, i.e. switching to "fit page" mode anyway.

Parameters
[in,out]pFitHeightDestinationActs as a handle to the native object of type TPtxPdfNav_FitHeightDestination.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitPageDestination_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_Create ( TPtxPdf_Document * pTargetDocument,
TPtxPdf_Page * pPage,
BOOL bFitActualContent )

Create a new FitPageDestination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in,out]pPageThe page in the document that this destination is pointing to.
[in]bFitActualContentIf TRUE, the viewport is fitted to the actual content of the page, instead of the size of the page. See property PtxPdfNav_FitPageDestination_GetFitActualContent for more information.
Returns
The newly created destination object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitPageDestination_GetFitActualContent()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_GetFitActualContent ( TPtxPdfNav_FitPageDestination * pFitPageDestination)

If TRUE, the viewport is fitted to the actual content of the page, instead of the size of the page.

Note: Many PDF viewers simply ignore this property and always treat it as FALSE, i.e. switching to "fit page" mode anyway.

Parameters
[in,out]pFitPageDestinationActs as a handle to the native object of type TPtxPdfNav_FitPageDestination.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitRectangleDestination_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_Create ( TPtxPdf_Document * pTargetDocument,
TPtxPdf_Page * pPage,
const TPtxGeomReal_Rectangle * pRectangle )

Create a new FitRectangleDestination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in,out]pPageThe page in the document that this destination is pointing to.
[in]pRectangleThe rectangle that is displayed in the viewport. See property PtxPdfNav_FitRectangleDestination_GetRectangle for more information.
Returns
The newly created destination object.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note
An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitRectangleDestination_GetRectangle()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_GetRectangle ( TPtxPdfNav_FitRectangleDestination * pFitRectangleDestination,
TPtxGeomReal_Rectangle * pRectangle )

The rectangle that is displayed in the viewport.

Parameters
[in,out]pFitRectangleDestinationActs as a handle to the native object of type TPtxPdfNav_FitRectangleDestination.
[out]pRectangleRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitWidthDestination_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_Create ( TPtxPdf_Document * pTargetDocument,
TPtxPdf_Page * pPage,
BOOL bFitActualContent )

Create a new FitWidthDestination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in,out]pPageThe page in the document that this destination is pointing to.
[in]bFitActualContentIf TRUE, the viewport is fitted to the actual content of the page, instead of the size of the page. See property PtxPdfNav_FitWidthDestination_GetFitActualContent for more information.
Returns
The newly created destination object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_FitWidthDestination_GetFitActualContent()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_GetFitActualContent ( TPtxPdfNav_FitWidthDestination * pFitWidthDestination)

If TRUE, the viewport is fitted to the width of the actual content of the page, instead of the width of the page.

Note: Many PDF viewers simply ignore this property and always treat it as FALSE, i.e. switching to "fit page" mode anyway.

Parameters
[in,out]pFitWidthDestinationActs as a handle to the native object of type TPtxPdfNav_FitWidthDestination.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_InternalLink_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_Create ( TPtxPdf_Document * pTargetDocument,
const TPtxGeomReal_Rectangle * pBoundingBox,
TPtxPdfNav_Destination * pTarget )

Create a document-internal link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in]pBoundingBoxThe location on the page.
[in,out]pTargetThe link target
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_InternalLink_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_CreateFromQuadrilaterals ( TPtxPdf_Document * pTargetDocument,
TPtxGeomReal_QuadrilateralList * pActiveArea,
TPtxPdfNav_Destination * pTarget )

Create a document-internal link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in,out]pActiveAreaThe active link area on the page.
[in,out]pTargetThe link target
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_InternalLink_GetDestination()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_GetDestination ( TPtxPdfNav_InternalLink * pInternalLink)

The link target.

Parameters
[in,out]pInternalLinkActs as a handle to the native object of type TPtxPdfNav_InternalLink.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_Copy()

Copy a link from an input document to a output document.

Parameters
[in,out]pTargetDocumentthe output document with which the returned object is associated
[in,out]pLinkthe link to be copied to the pTargetDocument
Returns
the copied link, associated with the pTargetDocument

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_GetActiveArea()

The link area The link is activated when a mouse click falls within the area defined by this list of TPtxGeomReal_Quadrilaterals.

Parameters
[in,out]pLinkActs as a handle to the native object of type TPtxPdfNav_Link.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_GetBoundingBox()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetBoundingBox ( TPtxPdfNav_Link * pLink,
TPtxGeomReal_Rectangle * pBoundingBox )

The location on the page.

Parameters
[in,out]pLinkActs as a handle to the native object of type TPtxPdfNav_Link.
[out]pBoundingBoxRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_GetHidden()

The link's visibility If TRUE then the link is present, but is invisible and not available for user interaction. Depending on the PtxPdfNav_Link_GetNoPrint property it will, however, still be visible when printing.

Parameters
[in,out]pLinkActs as a handle to the native object of type TPtxPdfNav_Link.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_GetNoPrint()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetNoPrint ( TPtxPdfNav_Link * pLink)

The link's visibility when printing If TRUE then the link is not present in a print output of the document.

Parameters
[in,out]pLinkActs as a handle to the native object of type TPtxPdfNav_Link.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_Link_GetType()

Get actual derived type of base type TPtxPdfNav_Link.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters
[in,out]pLinkActs as a handle to a native object.
Returns
The item of the enumeration TPtxPdfNav_LinkType that refers to the actual derived type. 0 in case of an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_Link_SetBorderStyle()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_SetBorderStyle ( TPtxPdfNav_Link * pLink,
TPtxPdfContent_Stroke * pBorderStyle )

The link's border This property defines if and how a rectangular border is drawn for the link.

Parameters
[in,out]pLinkActs as a handle to the native object of type TPtxPdfNav_Link.
[in,out]pBorderStyleSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LinkList_Add()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Add ( TPtxPdfNav_LinkList * pLinkList,
TPtxPdfNav_Link * pLink )

Add an element to the end of the list.

Parameters
[in,out]pLinkListActs as a handle to the native object of type TPtxPdfNav_LinkList.
[in,out]pLink
Returns
May indicate an error in certain scenarios. For further information see the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LinkList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Get ( TPtxPdfNav_LinkList * pLinkList,
int iIndex )

Returns the element at the specified position in the given list.

Parameters
[in,out]pLinkListActs as a handle to the native object of type TPtxPdfNav_LinkList.
[in]iIndex
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LinkList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_GetCount ( TPtxPdfNav_LinkList * pLinkList)

Get the number of elements in the list.

Parameters
[in,out]pLinkListActs as a handle to the native object of type TPtxPdfNav_LinkList.
Returns
May indicate an error in certain scenarios. For further information see the note section below.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LocationZoomDestination_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_Create ( TPtxPdf_Document * pTargetDocument,
TPtxPdf_Page * pPage,
const double * pLeft,
const double * pTop,
const double * pZoom )

Create a new LocationZoomDestination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in,out]pPageThe page in the document that this destination is pointing to.
[in]pLeftThe location of the page that is displayed at the left border of the viewport or NULL. See property PtxPdfNav_LocationZoomDestination_GetLeft for more information.
[in]pTopThe location of the page that is displayed at the top of the viewport or NULL. See property PtxPdfNav_LocationZoomDestination_GetTop for more information.
[in]pZoomThe zoom factor that is applied when jumping to the destination or NULL. See property PtxPdfNav_LocationZoomDestination_GetZoom for more information.
Returns
The newly created destination object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LocationZoomDestination_GetLeft()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetLeft ( TPtxPdfNav_LocationZoomDestination * pLocationZoomDestination,
double * pLeft )

The location of the page that is displayed at the left border of the viewport (if possible).

If the property is NULL, the value from before the jump is retained.

Note: Due to the current zoom factor, it is usually not possible for viewers to scroll as far to the right side, as would be necessary to place the location at the left corner of the viewport. However, viewers will ensure, that the location is at least visible.

In practice this means, that this value is mostly irrelevant.

Parameters
[in,out]pLocationZoomDestinationActs as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]pLeftRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LocationZoomDestination_GetTop()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetTop ( TPtxPdfNav_LocationZoomDestination * pLocationZoomDestination,
double * pTop )

The location of the page that is displayed at the top of the viewport (if possible).

If the property is NULL, the value from before the jump is retained.

Parameters
[in,out]pLocationZoomDestinationActs as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]pTopRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_LocationZoomDestination_GetZoom()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetZoom ( TPtxPdfNav_LocationZoomDestination * pLocationZoomDestination,
double * pZoom )

The zoom factor that is applied when jumping to the destination.

A value of NULL means that the current zoom level is retained.

Note: Many PDF viewers support different viewing modes like "fit page" or "fit width".

A TPtxPdfNav_LocationZoomDestination with a PtxPdfNav_LocationZoomDestination_GetZoom value of NULL will usually not change the current viewing mode in most viewers.

For other PtxPdfNav_LocationZoomDestination_GetZoom values however, the viewer must switch to the standard mode, i.e. deactivate special modes like "fit page" or "fit width".

Because of this, using a PtxPdfNav_LocationZoomDestination_GetZoom value other than NULL is discouraged.

Parameters
[in,out]pLocationZoomDestinationActs as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]pZoomRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_NamedDestination_CreateA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateA ( TPtxPdf_Document * pTargetDocument,
const char * szName,
TPtxPdfNav_DirectDestination * pTarget )

Create a named destination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in]szNameThe name by which the destination is referred to.
[in,out]pTargetThe target destination
Returns
The newly created named destination.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_NamedDestination_CreateW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateW ( TPtxPdf_Document * pTargetDocument,
const WCHAR * szName,
TPtxPdfNav_DirectDestination * pTarget )

Create a named destination The returned object is not yet used on any page, but it is associated with the given target document.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in]szNameThe name by which the destination is referred to.
[in,out]pTargetThe target destination
Returns
The newly created named destination.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_NamedDestination_GetNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameA ( TPtxPdfNav_NamedDestination * pNamedDestination,
char * pBuffer,
size_t nBufferSize )

The name by which the destination is referred to.

Parameters
[in,out]pNamedDestinationActs as a handle to the native object of type TPtxPdfNav_NamedDestination.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_NamedDestination_GetNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameW ( TPtxPdfNav_NamedDestination * pNamedDestination,
WCHAR * pBuffer,
size_t nBufferSize )

The name by which the destination is referred to.

Parameters
[in,out]pNamedDestinationActs as a handle to the native object of type TPtxPdfNav_NamedDestination.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure ( TPtxPdfNav_OutlineCopyOptions * pOutlineCopyOptions)

Copy the logical structure and tagging information.

Specifies whether the logical structure and tagging information associated with a an outline item is also copied when copying the item.

This is required if the target document conformance is PDF/A Level a.

Default value: TRUE

Parameters
[in,out]pOutlineCopyOptionsActs as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_OutlineCopyOptions_GetNamedDestinations()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetNamedDestinations ( TPtxPdfNav_OutlineCopyOptions * pOutlineCopyOptions)

Copy strategy for named destinations.

Specify whether named destinations are resolved when copying an outline item.

Default value: ePtxPdfNav_NamedDestinationCopyStrategy_Copy

Parameters
[in,out]pOutlineCopyOptionsActs as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_OutlineCopyOptions_New()

Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure ( TPtxPdfNav_OutlineCopyOptions * pOutlineCopyOptions,
BOOL bCopyLogicalStructure )

Copy the logical structure and tagging information.

Specifies whether the logical structure and tagging information associated with a an outline item is also copied when copying the item.

This is required if the target document conformance is PDF/A Level a.

Default value: TRUE

Parameters
[in,out]pOutlineCopyOptionsActs as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
[in]bCopyLogicalStructureSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_OutlineCopyOptions_SetNamedDestinations()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetNamedDestinations ( TPtxPdfNav_OutlineCopyOptions * pOutlineCopyOptions,
TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations )

Copy strategy for named destinations.

Specify whether named destinations are resolved when copying an outline item.

Default value: ePtxPdfNav_NamedDestinationCopyStrategy_Copy

Parameters
[in,out]pOutlineCopyOptionsActs as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
[in]iNamedDestinationsSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

◆ PtxPdfNav_OutlineItem_Copy()

Copy an outline item Copy an outline item object including all descendants from an input document to the given pTargetDocument. The returned object is associated with the given target document but not yet part of it.

Parameters
[in,out]pTargetDocumentthe output document with which the returned object is associated
[in,out]pOutlineItemAn outline item of a different document
[in,out]pOptionsThe options used to copy the item
Returns
The copied outline item, associated with the current document.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_CreateA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateA ( TPtxPdf_Document * pTargetDocument,
const char * szTitle,
TPtxPdfNav_Destination * pDestination )

Create a new outline item (bookmark). The returned outline item is not yet part of the outline item tree, but it is associated with the given target document. It can be inserted at any position in the tree.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in]szTitleThe title of the newly created outline item.
[in,out]pDestinationThe destination that this outline item refers to or NULL if the item has no destination.
Returns
The newly created outline item.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_CreateW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateW ( TPtxPdf_Document * pTargetDocument,
const WCHAR * szTitle,
TPtxPdfNav_Destination * pDestination )

Create a new outline item (bookmark). The returned outline item is not yet part of the outline item tree, but it is associated with the given target document. It can be inserted at any position in the tree.

Parameters
[in,out]pTargetDocumentThe output document with which the returned object is associated
[in]szTitleThe title of the newly created outline item.
[in,out]pDestinationThe destination that this outline item refers to or NULL if the item has no destination.
Returns
The newly created outline item.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetBold()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetBold ( TPtxPdfNav_OutlineItem * pOutlineItem)

If TRUE, the outline item is displayed in bold font.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetChildren()

The child items of this outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetDestination()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetDestination ( TPtxPdfNav_OutlineItem * pOutlineItem)

The destination of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
Returns
Retrieved value.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note
An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetItalic()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetItalic ( TPtxPdfNav_OutlineItem * pOutlineItem)

If TRUE, the outline item is displayed in italic font.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetTitleA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleA ( TPtxPdfNav_OutlineItem * pOutlineItem,
char * pBuffer,
size_t nBufferSize )

The title of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_GetTitleW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleW ( TPtxPdfNav_OutlineItem * pOutlineItem,
WCHAR * pBuffer,
size_t nBufferSize )

The title of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_IsOpen()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_IsOpen ( TPtxPdfNav_OutlineItem * pOutlineItem)
  • If TRUE, the item is expanded.
  • If FALSE, the item is collapsed. This is property is only meaningful if the item has child items.
Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetBold()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetBold ( TPtxPdfNav_OutlineItem * pOutlineItem,
BOOL bBold )

If TRUE, the outline item is displayed in bold font.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]bBoldSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetDestination()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetDestination ( TPtxPdfNav_OutlineItem * pOutlineItem,
TPtxPdfNav_Destination * pDestination )

The destination of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in,out]pDestinationSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetIsOpen()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetIsOpen ( TPtxPdfNav_OutlineItem * pOutlineItem,
BOOL bIsOpen )
  • If TRUE, the item is expanded.
  • If FALSE, the item is collapsed. This is property is only meaningful if the item has child items.
Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]bIsOpenSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetItalic()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetItalic ( TPtxPdfNav_OutlineItem * pOutlineItem,
BOOL bItalic )

If TRUE, the outline item is displayed in italic font.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]bItalicSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetTitleA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleA ( TPtxPdfNav_OutlineItem * pOutlineItem,
const char * szTitle )

The title of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]szTitleSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItem_SetTitleW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleW ( TPtxPdfNav_OutlineItem * pOutlineItem,
const WCHAR * szTitle )

The title of the outline item.

Parameters
[in,out]pOutlineItemActs as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]szTitleSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_Add()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Add ( TPtxPdfNav_OutlineItemList * pOutlineItemList,
TPtxPdfNav_OutlineItem * pOutlineItem )

Add an element to the end of the list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
[in,out]pOutlineItem
Returns
May indicate an error in certain scenarios. For further information see the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_Clear()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Clear ( TPtxPdfNav_OutlineItemList * pOutlineItemList)

Clear list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Get ( TPtxPdfNav_OutlineItemList * pOutlineItemList,
int iIndex )

Returns the element at the specified position in the given list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
[in]iIndex
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_GetCount ( TPtxPdfNav_OutlineItemList * pOutlineItemList)

Get the number of elements in the list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
Returns
May indicate an error in certain scenarios. For further information see the note section below.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_Remove()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Remove ( TPtxPdfNav_OutlineItemList * pOutlineItemList,
int iIndex )

Remove certain element from list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
[in]iIndex
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_OutlineItemList_Set()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Set ( TPtxPdfNav_OutlineItemList * pOutlineItemList,
int iIndex,
TPtxPdfNav_OutlineItem * pValue )

Update certain element in list.

Parameters
[in,out]pOutlineItemListActs as a handle to the native object of type TPtxPdfNav_OutlineItemList.
[in]iIndex
[in,out]pValue
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_Copy()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_Copy ( TPtxPdf_Document * pTargetDocument,
TPtxPdfNav_ViewerSettings * pViewerSettings )

Copy viewer settings The newly created viewer settings are associated with the target document, but not yet used as the document's viewer settings.

Parameters
[in,out]pTargetDocumentthe output document with which the returned object is associated
[in,out]pViewerSettingsthe viewer settings of a different document
Returns
a viewer settings object with the same content, but associated with the current document.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetActivePane()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetActivePane ( TPtxPdfNav_ViewerSettings * pViewerSettings,
TPtxPdfNav_ViewerNavigationPane * pActivePane )

The initially visible side pane when opening the document in a viewer. If NULL then the viewer acts according to it's default behavior.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[out]pActivePaneRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle ( TPtxPdfNav_ViewerSettings * pViewerSettings)

If TRUE then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetFullScreen()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetFullScreen ( TPtxPdfNav_ViewerSettings * pViewerSettings)

If TRUE then opening the document will make the viewer try to enter full screen mode.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetHideMenubar()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideMenubar ( TPtxPdfNav_ViewerSettings * pViewerSettings)

If TRUE then opening the document will instruct the viewer to hide it's menu bar.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetHideToolbar()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideToolbar ( TPtxPdfNav_ViewerSettings * pViewerSettings)

If TRUE then opening the document will instruct the viewer to hide it's toolbar.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_GetPageDisplay()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetPageDisplay ( TPtxPdfNav_ViewerSettings * pViewerSettings,
TPtxPdfNav_PageDisplay * pPageDisplay )

The positional arrangment for displaying pages when opening the document in a viewer. If NULL then the viewer acts according to it's default behavior.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[out]pPageDisplayRetrieved value.
Returns
FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.
Note
An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetActivePane()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetActivePane ( TPtxPdfNav_ViewerSettings * pViewerSettings,
const TPtxPdfNav_ViewerNavigationPane * pActivePane )

The initially visible side pane when opening the document in a viewer. If NULL then the viewer acts according to it's default behavior.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]pActivePaneSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle ( TPtxPdfNav_ViewerSettings * pViewerSettings,
BOOL bDisplayDocumentTitle )

If TRUE then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]bDisplayDocumentTitleSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetFullScreen()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetFullScreen ( TPtxPdfNav_ViewerSettings * pViewerSettings,
BOOL bFullScreen )

If TRUE then opening the document will make the viewer try to enter full screen mode.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]bFullScreenSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetHideMenubar()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideMenubar ( TPtxPdfNav_ViewerSettings * pViewerSettings,
BOOL bHideMenubar )

If TRUE then opening the document will instruct the viewer to hide it's menu bar.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]bHideMenubarSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetHideToolbar()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideToolbar ( TPtxPdfNav_ViewerSettings * pViewerSettings,
BOOL bHideToolbar )

If TRUE then opening the document will instruct the viewer to hide it's toolbar.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]bHideToolbarSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_ViewerSettings_SetPageDisplay()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetPageDisplay ( TPtxPdfNav_ViewerSettings * pViewerSettings,
const TPtxPdfNav_PageDisplay * pPageDisplay )

The positional arrangment for displaying pages when opening the document in a viewer. If NULL then the viewer acts according to it's default behavior.

Parameters
[in,out]pViewerSettingsActs as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]pPageDisplaySet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_CreateA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateA ( TPtxPdf_Document * pTargetDocument,
const TPtxGeomReal_Rectangle * pBoundingBox,
const char * szUri )

Create an external link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in]pBoundingBoxThe location on the page.
[in]szUriThe link target
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_CreateFromQuadrilateralsA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsA ( TPtxPdf_Document * pTargetDocument,
TPtxGeomReal_QuadrilateralList * pActiveArea,
const char * szUri )

Create an external link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in,out]pActiveAreaThe active link area on the page.
[in]szUriThe link target
Returns
The newly created object

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note
An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_CreateFromQuadrilateralsW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsW ( TPtxPdf_Document * pTargetDocument,
TPtxGeomReal_QuadrilateralList * pActiveArea,
const WCHAR * szUri )

Create an external link with defined link area The link has an active area defined by the given pActiveArea. The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in,out]pActiveAreaThe active link area on the page.
[in]szUriThe link target
Returns
The newly created object

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note
An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_CreateW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateW ( TPtxPdf_Document * pTargetDocument,
const TPtxGeomReal_Rectangle * pBoundingBox,
const WCHAR * szUri )

Create an external link The link is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of links.

Parameters
[in,out]pTargetDocumentThe document in which the links is used
[in]pBoundingBoxThe location on the page.
[in]szUriThe link target
Returns
The newly created object

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_GetUriA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriA ( TPtxPdfNav_WebLink * pWebLink,
char * pBuffer,
size_t nBufferSize )

The link target.

Parameters
[in,out]pWebLinkActs as a handle to the native object of type TPtxPdfNav_WebLink.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_GetUriW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriW ( TPtxPdfNav_WebLink * pWebLink,
WCHAR * pBuffer,
size_t nBufferSize )

The link target.

Parameters
[in,out]pWebLinkActs as a handle to the native object of type TPtxPdfNav_WebLink.
[out]pBufferRetrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe buffer size of the retrieved string pBuffer.
Returns
The amount of data written to the buffer pBuffer. 0 if there is an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_SetUriA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriA ( TPtxPdfNav_WebLink * pWebLink,
const char * szUri )

The link target.

Parameters
[in,out]pWebLinkActs as a handle to the native object of type TPtxPdfNav_WebLink.
[in]szUriSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

◆ PtxPdfNav_WebLink_SetUriW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriW ( TPtxPdfNav_WebLink * pWebLink,
const WCHAR * szUri )

The link target.

Parameters
[in,out]pWebLinkActs as a handle to the native object of type TPtxPdfNav_WebLink.
[in]szUriSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes: