PdfToolbox_PtxPdfNav.h File Reference

#include "PdfToolbox_Types.h"
#include "PdfToolbox_PtxSys.h"

Go to the source code of this file.

Macros
#define	PDFTOOLBOX_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
PDFTOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetPageDisplay (TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetPageDisplay (TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetActivePane (TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetActivePane (TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetFullScreen (TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetFullScreen (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bFullScreen)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetHideToolbar (TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetHideToolbar (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideToolbar)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetHideMenubar (TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetHideMenubar (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideMenubar)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle (TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle (TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bDisplayDocumentTitle)
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetTitleA (TPtxPdfNav_OutlineItem *pOutlineItem, char *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetTitleW (TPtxPdfNav_OutlineItem *pOutlineItem, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetTitleA (TPtxPdfNav_OutlineItem *pOutlineItem, const char *szTitle)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetTitleW (TPtxPdfNav_OutlineItem *pOutlineItem, const WCHAR *szTitle)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetBold (TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetBold (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bBold)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetItalic (TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetItalic (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bItalic)
PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetDestination (TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetDestination (TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_Destination *pDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_IsOpen (TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_SetIsOpen (TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bIsOpen)
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLBOX_CALL	PtxPdfNav_OutlineItem_GetChildren (TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_GetCount (TPtxPdfNav_OutlineItemList *pOutlineItemList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_Get (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_Add (TPtxPdfNav_OutlineItemList *pOutlineItemList, TPtxPdfNav_OutlineItem *pOutlineItem)
	Add an element to the end of the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_Clear (TPtxPdfNav_OutlineItemList *pOutlineItemList)
	Clear list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_Remove (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
	Remove certain element from list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineItemList_Set (TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex, TPtxPdfNav_OutlineItem *pValue)
	Update certain element in list.
PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestination *PDFTOOLBOX_CALL	PtxPdfNav_Destination_GetTarget (TPtxPdfNav_Destination *pDestination)
	The target destination For direct destinations, this is just the destination itself.
PDFTOOLBOX_EXPORT TPtxPdfNav_DestinationType PDFTOOLBOX_CALL	PtxPdfNav_Destination_GetType (TPtxPdfNav_Destination *pDestination)
	Get actual derived type of base type TPtxPdfNav_Destination.
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_NamedDestination_GetNameA (TPtxPdfNav_NamedDestination *pNamedDestination, char *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_NamedDestination_GetNameW (TPtxPdfNav_NamedDestination *pNamedDestination, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_CALL	PtxPdfNav_DirectDestination_GetPage (TPtxPdfNav_DirectDestination *pDirectDestination)
PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestinationType PDFTOOLBOX_CALL	PtxPdfNav_DirectDestination_GetType (TPtxPdfNav_DirectDestination *pDirectDestination)
	Get actual derived type of base type TPtxPdfNav_DirectDestination.
PDFTOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_LocationZoomDestination_GetLeft (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pLeft)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_LocationZoomDestination_GetTop (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pTop)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_LocationZoomDestination_GetZoom (TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pZoom)
PDFTOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_FitPageDestination_GetFitActualContent (TPtxPdfNav_FitPageDestination *pFitPageDestination)
PDFTOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_FitWidthDestination_GetFitActualContent (TPtxPdfNav_FitWidthDestination *pFitWidthDestination)
PDFTOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_FitHeightDestination_GetFitActualContent (TPtxPdfNav_FitHeightDestination *pFitHeightDestination)
PDFTOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_FitRectangleDestination_GetRectangle (TPtxPdfNav_FitRectangleDestination *pFitRectangleDestination, TPtxGeomReal_Rectangle *pRectangle)
PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL	PtxPdfNav_Link_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfNav_Link *pLink)
	Copy a link from an input document to a output document.
PDFTOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_Link_GetBoundingBox (TPtxPdfNav_Link *pLink, TPtxGeomReal_Rectangle *pBoundingBox)
	The location on the page.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_LinkType PDFTOOLBOX_CALL	PtxPdfNav_Link_GetType (TPtxPdfNav_Link *pLink)
	Get actual derived type of base type TPtxPdfNav_Link.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfNav_LinkList_GetCount (TPtxPdfNav_LinkList *pLinkList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL	PtxPdfNav_LinkList_Get (TPtxPdfNav_LinkList *pLinkList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_LinkList_Add (TPtxPdfNav_LinkList *pLinkList, TPtxPdfNav_Link *pLink)
	Add an element to the end of the list.
PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL	PtxPdfNav_InternalLink_GetDestination (TPtxPdfNav_InternalLink *pInternalLink)
	The link target.
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_WebLink_GetUriA (TPtxPdfNav_WebLink *pWebLink, char *pBuffer, size_t nBufferSize)
	The link target.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfNav_WebLink_GetUriW (TPtxPdfNav_WebLink *pWebLink, WCHAR *pBuffer, size_t nBufferSize)
	The link target.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_WebLink_SetUriA (TPtxPdfNav_WebLink *pWebLink, const char *szUri)
	The link target.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_WebLink_SetUriW (TPtxPdfNav_WebLink *pWebLink, const WCHAR *szUri)
	The link target.
PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_EmbeddedPdfLink_GetNewWindow (TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, BOOL *pNewWindow)
	The opening behavior This defines the viewer's behavior when opening the target PDF document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineCopyOptions *PDFTOOLBOX_CALL	PtxPdfNav_OutlineCopyOptions_New (void)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
	Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, BOOL bCopyLogicalStructure)
	Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLBOX_CALL	PtxPdfNav_OutlineCopyOptions_GetNamedDestinations (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
	Copy strategy for named destinations.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfNav_OutlineCopyOptions_SetNamedDestinations (TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
	Copy strategy for named destinations.

Macro Definition Documentation

PDFTOOLBOX_CALL

#define PDFTOOLBOX_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()

PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestination *PDFTOOLBOX_CALL PtxPdfNav_Destination_GetTarget

(

TPtxPdfNav_Destination *

pDestination

)

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

Parameters

[in,out]

pDestination

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_Destination_GetType()

PDFTOOLBOX_EXPORT TPtxPdfNav_DestinationType PDFTOOLBOX_CALL PtxPdfNav_Destination_GetType

(

TPtxPdfNav_Destination *

pDestination

)

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]

pDestination

Acts 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()

PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_CALL PtxPdfNav_DirectDestination_GetPage

(

TPtxPdfNav_DirectDestination *

pDirectDestination

)

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

Parameters

[in,out]

pDirectDestination

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_Corrupt the page could not be found or does not exist in the document.

PtxPdfNav_DirectDestination_GetType()

PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestinationType PDFTOOLBOX_CALL PtxPdfNav_DirectDestination_GetType

(

TPtxPdfNav_DirectDestination *

pDirectDestination

)

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]

pDirectDestination

Acts 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()

PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in]	pBoundingBox	The location on the page
[in,out]	pFileReference	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pFileReference argument has already been closed
• ePtx_Error_IllegalArgument if the pFileReference argument does not contain a PDF document
• ePtx_Error_IllegalArgument if the pFileReference argument is neither used in a file attachment annotation nor has it been appended to the pTargetDocument's list of plain embedded or associated files.
• ePtx_Error_IllegalArgument if the pFileReference argument is used in a file attachment annotation and this annotation has not been appended to a page's list of annotations.

PtxPdfNav_EmbeddedPdfLink_CreateFromQuadrilaterals()

PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in,out]	pActiveArea	The active link area on the page.
[in,out]	pFileReference	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pFileReference argument has already been closed
• ePtx_Error_IllegalArgument if the pFileReference argument does not contain a PDF document
• ePtx_Error_IllegalArgument if the pFileReference argument is neither used in a file attachment annotation nor has it been appended to the pTargetDocument's list of plain embedded or associated files.
• ePtx_Error_IllegalArgument if the pFileReference argument is used in a file attachment annotation and this annotation has not been appended to a page's list of annotations.
• ePtx_Error_IllegalArgument if the pActiveArea is empty

PtxPdfNav_EmbeddedPdfLink_GetNewWindow()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pEmbeddedPdfLink	Acts as a handle to the native object of type TPtxPdfNav_EmbeddedPdfLink.
[out]	pNewWindow	Retrieved 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the annotation has already been appended to a page's list of annotations

PtxPdfNav_EmbeddedPdfLink_SetNewWindow()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pEmbeddedPdfLink	Acts as a handle to the native object of type TPtxPdfNav_EmbeddedPdfLink.
[in]	pNewWindow	Set 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the annotation has already been appended to a page's list of annotations

PtxPdfNav_FitHeightDestination_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in,out]	pPage	The page in the document that this destination is pointing to.
[in]	bFitActualContent	If 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTargetDocumentdiffers from the document associated with pPage
• ePtx_Error_IllegalArgument If the document associated with the pPage argument has already been closed

PtxPdfNav_FitHeightDestination_GetFitActualContent()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pFitHeightDestination

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_FitPageDestination_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in,out]	pPage	The page in the document that this destination is pointing to.
[in]	bFitActualContent	If 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTargetDocumentdiffers from the document associated with pPage
• ePtx_Error_IllegalArgument If the document associated with the pPage argument has already been closed

PtxPdfNav_FitPageDestination_GetFitActualContent()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pFitPageDestination

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_FitRectangleDestination_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in,out]	pPage	The page in the document that this destination is pointing to.
[in]	pRectangle	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTargetDocumentdiffers from the document associated with pPage
• ePtx_Error_IllegalArgument If the document associated with the pPage argument has already been closed

PtxPdfNav_FitRectangleDestination_GetRectangle()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_FitRectangleDestination_GetRectangle	(	TPtxPdfNav_FitRectangleDestination *	pFitRectangleDestination,
		TPtxGeomReal_Rectangle *	pRectangle )

The rectangle that is displayed in the viewport.

Parameters

[in,out]	pFitRectangleDestination	Acts as a handle to the native object of type TPtxPdfNav_FitRectangleDestination.
[out]	pRectangle	Retrieved 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_FitWidthDestination_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in,out]	pPage	The page in the document that this destination is pointing to.
[in]	bFitActualContent	If 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTargetDocumentdiffers from the document associated with pPage
• ePtx_Error_IllegalArgument If the document associated with the pPage argument has already been closed.

PtxPdfNav_FitWidthDestination_GetFitActualContent()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pFitWidthDestination

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_InternalLink_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in]	pBoundingBox	The location on the page.
[in,out]	pTarget	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTarget argument is not associated with the pTargetDocument

PtxPdfNav_InternalLink_CreateFromQuadrilaterals()

PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in,out]	pActiveArea	The active link area on the page.
[in,out]	pTarget	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTarget argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pActiveArea is empty

PtxPdfNav_InternalLink_GetDestination()

PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL PtxPdfNav_InternalLink_GetDestination

(

TPtxPdfNav_InternalLink *

pInternalLink

)

The link target.

Parameters

[in,out]

pInternalLink

Acts 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_IllegalState if the link has no destination

PtxPdfNav_Link_Copy()

PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL PtxPdfNav_Link_Copy	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfNav_Link *	pLink )

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

Parameters

[in,out]	pTargetDocument	the output document with which the returned object is associated
[in,out]	pLink	the 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:

• ePtx_Error_IllegalArgument if the pTargetDocument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument is read-only
• ePtx_Error_IllegalArgument if the pLink is not associated with an input document
• ePtx_Error_IllegalArgument if the document associated with the pLink object has already been closed
• ePtx_Error_Conformance The conformance level of the input document is not compatible with the conformance level of the pTargetDocument.
• ePtx_Error_IO Error reading from the input document or writing to the output document

PtxPdfNav_Link_GetActiveArea()

PDFTOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLBOX_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.

Parameters

[in,out]

pLink

Acts 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_Corrupt if the PDF is corrupt

PtxPdfNav_Link_GetBoundingBox()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_Link_GetBoundingBox	(	TPtxPdfNav_Link *	pLink,
		TPtxGeomReal_Rectangle *	pBoundingBox )

The location on the page.

Parameters

[in,out]	pLink	Acts as a handle to the native object of type TPtxPdfNav_Link.
[out]	pBoundingBox	Retrieved 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_Corrupt if the PDF is corrupt

PtxPdfNav_Link_GetHidden()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.

Parameters

[in,out]

pLink

Acts 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:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfNav_Link_GetNoPrint()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pLink

Acts 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:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfNav_Link_GetType()

PDFTOOLBOX_EXPORT TPtxPdfNav_LinkType PDFTOOLBOX_CALL PtxPdfNav_Link_GetType

(

TPtxPdfNav_Link *

pLink

)

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]

pLink

Acts 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()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pLink	Acts as a handle to the native object of type TPtxPdfNav_Link.
[in,out]	pBorderStyle	Set 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object is associated with a different document
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object has a PtxPdfContent_Stroke_GetDashPhase differing from 0
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object has a PtxPdfContent_Stroke_GetMiterLimit differing from 10
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object has a PtxPdfContent_Stroke_GetLineCapStyle other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object has a PtxPdfContent_Stroke_GetLineJoinStyle other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument the given TPtxPdfContent_Stroke object's PtxPdfContent_Stroke_GetPaint has a color space other than a device color space, or a calibrated color space.
• ePtx_Error_UnsupportedFeature the given TPtxPdfContent_Stroke object's PtxPdfContent_Stroke_GetPaint has a DeviceGray, DeviceCMYK, or CalGray color space.

PtxPdfNav_LinkList_Add()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_LinkList_Add	(	TPtxPdfNav_LinkList *	pLinkList,
		TPtxPdfNav_Link *	pLink )

Add an element to the end of the list.

Parameters

[in,out]	pLinkList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_LinkList_Get()

PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL PtxPdfNav_LinkList_Get	(	TPtxPdfNav_LinkList *	pLinkList,
		int	iIndex )

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

Parameters

[in,out]	pLinkList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_LinkList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfNav_LinkList_GetCount

(

TPtxPdfNav_LinkList *

pLinkList

)

Get the number of elements in the list.

Parameters

[in,out]

pLinkList

Acts 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:

• ePtx_Error_IllegalState

PtxPdfNav_LocationZoomDestination_Create()

PDFTOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in,out]	pPage	The page in the document that this destination is pointing to.
[in]	pLeft	The 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]	pTop	The location of the page that is displayed at the top of the viewport or NULL. See property PtxPdfNav_LocationZoomDestination_GetTop for more information.
[in]	pZoom	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pTargetDocumentdiffers from the document associated with pPage
• ePtx_Error_IllegalArgument If the document associated with the pPage argument has already been closed

PtxPdfNav_LocationZoomDestination_GetLeft()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pLocationZoomDestination	Acts as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]	pLeft	Retrieved 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_LocationZoomDestination_GetTop()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pLocationZoomDestination	Acts as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]	pTop	Retrieved 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_LocationZoomDestination_GetZoom()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pLocationZoomDestination	Acts as a handle to the native object of type TPtxPdfNav_LocationZoomDestination.
[out]	pZoom	Retrieved 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_NamedDestination_CreateA()

PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in]	szName	The name by which the destination is referred to.
[in,out]	pTarget	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pTarget argument has already been closed
• ePtx_Error_IllegalArgument if the pTarget argument belongs to a different document

PtxPdfNav_NamedDestination_CreateW()

PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in]	szName	The name by which the destination is referred to.
[in,out]	pTarget	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pTarget argument has already been closed
• ePtx_Error_IllegalArgument if the pTarget argument belongs to a different document

PtxPdfNav_NamedDestination_GetNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameA	(	TPtxPdfNav_NamedDestination *	pNamedDestination,
		char *	pBuffer,
		size_t	nBufferSize )

The name by which the destination is referred to.

Parameters

[in,out]	pNamedDestination	Acts as a handle to the native object of type TPtxPdfNav_NamedDestination.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_NamedDestination_GetNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameW	(	TPtxPdfNav_NamedDestination *	pNamedDestination,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name by which the destination is referred to.

Parameters

[in,out]	pNamedDestination	Acts as a handle to the native object of type TPtxPdfNav_NamedDestination.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pOutlineCopyOptions

Acts 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()

PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLBOX_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]

pOutlineCopyOptions

Acts 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()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineCopyOptions *PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_New

(

void

)

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()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pOutlineCopyOptions	Acts as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
[in]	bCopyLogicalStructure	Set 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()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pOutlineCopyOptions	Acts as a handle to the native object of type TPtxPdfNav_OutlineCopyOptions.
[in]	iNamedDestinations	Set 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()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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.

Parameters

[in,out]	pTargetDocument	the output document with which the returned object is associated
[in,out]	pOutlineItem	An outline item of a different document
[in,out]	pOptions	The 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:

• ePtx_Error_Conformance The conformance level of the source document is not compatible with the conformance level of the target document.
• ePtx_Error_IllegalArgument if the pTargetDocument argument is NULL
• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pOutlineItem argument is not associated with an input document
• ePtx_Error_IllegalArgument the target document contains implicitly copied outline items
• ePtx_Error_IllegalArgument the pOutlineItem argument is NULL
• ePtx_Error_IllegalArgument the pOutlineItem argument is not associated with an input document
• ePtx_Error_IO Error reading from the source document or writing to the target document

PtxPdfNav_OutlineItem_CreateA()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in]	szTitle	The title of the newly created outline item.
[in,out]	pDestination	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pDestination argument has already been closed
• ePtx_Error_IllegalArgument if the pDestination argument belongs to a different document

PtxPdfNav_OutlineItem_CreateW()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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]	pTargetDocument	The output document with which the returned object is associated
[in]	szTitle	The title of the newly created outline item.
[in,out]	pDestination	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the document associated with the pDestination argument has already been closed
• ePtx_Error_IllegalArgument if the pDestination argument belongs to a different document

PtxPdfNav_OutlineItem_GetBold()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetBold

(

TPtxPdfNav_OutlineItem *

pOutlineItem

)

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

Parameters

[in,out]

pOutlineItem

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_GetChildren()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetChildren

(

TPtxPdfNav_OutlineItem *

pOutlineItem

)

The child items of this outline item.

Parameters

[in,out]

pOutlineItem

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.

PtxPdfNav_OutlineItem_GetDestination()

PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetDestination

(

TPtxPdfNav_OutlineItem *

pOutlineItem

)

The destination of the outline item.

Parameters

[in,out]

pOutlineItem

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an input document.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_GetItalic()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetItalic

(

TPtxPdfNav_OutlineItem *

pOutlineItem

)

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

Parameters

[in,out]

pOutlineItem

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_GetTitleA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleA	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		char *	pBuffer,
		size_t	nBufferSize )

The title of the outline item.

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_GetTitleW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleW	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The title of the outline item.

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_IsOpen()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pOutlineItem

Acts 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetBold()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetBold	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		BOOL	bBold )

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

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]	bBold	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetDestination()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetDestination	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		TPtxPdfNav_Destination *	pDestination )

The destination of the outline item.

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in,out]	pDestination	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an input document.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetIsOpen()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]	bIsOpen	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetItalic()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetItalic	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		BOOL	bItalic )

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

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]	bItalic	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetTitleA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleA	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		const char *	szTitle )

The title of the outline item.

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]	szTitle	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItem_SetTitleW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleW	(	TPtxPdfNav_OutlineItem *	pOutlineItem,
		const WCHAR *	szTitle )

The title of the outline item.

Parameters

[in,out]	pOutlineItem	Acts as a handle to the native object of type TPtxPdfNav_OutlineItem.
[in]	szTitle	Set 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:

• ePtx_Error_IllegalState the object has already been closed.
• ePtx_Error_IllegalState the associated document has already been closed.
• ePtx_Error_UnsupportedOperation the object is not associated to an output document.

PtxPdfNav_OutlineItemList_Add()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Add	(	TPtxPdfNav_OutlineItemList *	pOutlineItemList,
		TPtxPdfNav_OutlineItem *	pOutlineItem )

Add an element to the end of the list.

Parameters

[in,out]	pOutlineItemList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_OutlineItemList_Clear()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Clear

(

TPtxPdfNav_OutlineItemList *

pOutlineItemList

)

Clear list.

Parameters

[in,out]

pOutlineItemList

Acts 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:

• ePtx_Error_IllegalState

PtxPdfNav_OutlineItemList_Get()

PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Get	(	TPtxPdfNav_OutlineItemList *	pOutlineItemList,
		int	iIndex )

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

Parameters

[in,out]	pOutlineItemList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_OutlineItemList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_GetCount

(

TPtxPdfNav_OutlineItemList *

pOutlineItemList

)

Get the number of elements in the list.

Parameters

[in,out]

pOutlineItemList

Acts 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:

• ePtx_Error_IllegalState

PtxPdfNav_OutlineItemList_Remove()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Remove	(	TPtxPdfNav_OutlineItemList *	pOutlineItemList,
		int	iIndex )

Remove certain element from list.

Parameters

[in,out]	pOutlineItemList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_OutlineItemList_Set()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Set	(	TPtxPdfNav_OutlineItemList *	pOutlineItemList,
		int	iIndex,
		TPtxPdfNav_OutlineItem *	pValue )

Update certain element in list.

Parameters

[in,out]	pOutlineItemList	Acts 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:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfNav_ViewerSettings_Copy()

PDFTOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLBOX_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]	pTargetDocument	the output document with which the returned object is associated
[in,out]	pViewerSettings	the 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:

• ePtx_Error_Conformance The conformance level of the source document is not compatible with the conformance level of the target document.
• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pViewerSettings argument is not associated with an input document
• ePtx_Error_IllegalArgument if the document associated with the pViewerSettings object has already been closed
• ePtx_Error_IO Error reading from the stream

PtxPdfNav_ViewerSettings_GetActivePane()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[out]	pActivePane	Retrieved 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pViewerSettings

Acts 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_GetFullScreen()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pViewerSettings

Acts 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_GetHideMenubar()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pViewerSettings

Acts 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_GetHideToolbar()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]

pViewerSettings

Acts 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_GetPageDisplay()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[out]	pPageDisplay	Retrieved 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetActivePane()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	pActivePane	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	bDisplayDocumentTitle	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetFullScreen()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	bFullScreen	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetHideMenubar()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	bHideMenubar	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetHideToolbar()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	bHideToolbar	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_ViewerSettings_SetPageDisplay()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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]	pViewerSettings	Acts as a handle to the native object of type TPtxPdfNav_ViewerSettings.
[in]	pPageDisplay	Set 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:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfNav_WebLink_CreateA()

PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in]	pBoundingBox	The location on the page.
[in]	szUri	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the szUri is empty

PtxPdfNav_WebLink_CreateFromQuadrilateralsA()

PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in,out]	pActiveArea	The active link area on the page.
[in]	szUri	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pActiveArea is empty
• ePtx_Error_IllegalArgument if the szUri is empty

PtxPdfNav_WebLink_CreateFromQuadrilateralsW()

PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in,out]	pActiveArea	The active link area on the page.
[in]	szUri	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the pActiveArea is empty
• ePtx_Error_IllegalArgument if the szUri is empty

PtxPdfNav_WebLink_CreateW()

PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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]	pTargetDocument	The document in which the links is used
[in]	pBoundingBox	The location on the page.
[in]	szUri	The 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:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument if the szUri is empty

PtxPdfNav_WebLink_GetUriA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_WebLink_GetUriA	(	TPtxPdfNav_WebLink *	pWebLink,
		char *	pBuffer,
		size_t	nBufferSize )

The link target.

Parameters

[in,out]	pWebLink	Acts as a handle to the native object of type TPtxPdfNav_WebLink.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is empty
• ePtx_Error_IllegalState if the link has already been appended to a page's list of links

PtxPdfNav_WebLink_GetUriW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_WebLink_GetUriW	(	TPtxPdfNav_WebLink *	pWebLink,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The link target.

Parameters

[in,out]	pWebLink	Acts as a handle to the native object of type TPtxPdfNav_WebLink.
[out]	pBuffer	Retrieved 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]	nBufferSize	The 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is empty
• ePtx_Error_IllegalState if the link has already been appended to a page's list of links

PtxPdfNav_WebLink_SetUriA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_WebLink_SetUriA	(	TPtxPdfNav_WebLink *	pWebLink,
		const char *	szUri )

The link target.

Parameters

[in,out]	pWebLink	Acts as a handle to the native object of type TPtxPdfNav_WebLink.
[in]	szUri	Set 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is empty
• ePtx_Error_IllegalState if the link has already been appended to a page's list of links

PtxPdfNav_WebLink_SetUriW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_WebLink_SetUriW	(	TPtxPdfNav_WebLink *	pWebLink,
		const WCHAR *	szUri )

The link target.

Parameters

[in,out]	pWebLink	Acts as a handle to the native object of type TPtxPdfNav_WebLink.
[in]	szUri	Set 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:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is empty
• ePtx_Error_IllegalState if the link has already been appended to a page's list of links