PdfTools_Toolbox_PtxPdfAnnots.h File Reference

#include "PdfTools_Toolbox_Types.h"
#include "PdfTools_Toolbox_PtxSys.h"

Go to the source code of this file.

Macros
#define	PDFTOOLS_TOOLBOX_CALL
#define	PtxPdfAnnots_Annotation_GetId   PtxPdfAnnots_Annotation_GetIdA
#define	PtxPdfAnnots_MarkupInfo_GetAuthor   PtxPdfAnnots_MarkupInfo_GetAuthorA
#define	PtxPdfAnnots_MarkupInfo_SetAuthor   PtxPdfAnnots_MarkupInfo_SetAuthorA
#define	PtxPdfAnnots_MarkupInfo_GetSubject   PtxPdfAnnots_MarkupInfo_GetSubjectA
#define	PtxPdfAnnots_MarkupInfo_SetSubject   PtxPdfAnnots_MarkupInfo_SetSubjectA
#define	PtxPdfAnnots_MarkupInfo_GetContent   PtxPdfAnnots_MarkupInfo_GetContentA
#define	PtxPdfAnnots_MarkupInfo_SetContent   PtxPdfAnnots_MarkupInfo_SetContentA
#define	PtxPdfAnnots_StickyNote_Create   PtxPdfAnnots_StickyNote_CreateA
#define	PtxPdfAnnots_TextStamp_CreateRaw   PtxPdfAnnots_TextStamp_CreateRawA
#define	PtxPdfAnnots_FreeText_Create   PtxPdfAnnots_FreeText_CreateA

Functions
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfAnnots_Annotation *pAnnotation)
	Copy an annotation Copy an annotation object from an input document to the given pTargetDocument. The returned object is associated with the given target document but not yet part of it.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetBoundingBox (TPtxPdfAnnots_Annotation *pAnnotation, TPtxGeomReal_Rectangle *pBoundingBox)
	The location on the page.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetHidden (TPtxPdfAnnots_Annotation *pAnnotation)
	The annotation's visibility If TRUE then the annotation is present, but is invisible and not available for user interaction. Depending on the PtxPdfAnnots_Annotation_GetNoPrint property it will, however, still be visible when printing.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetNoPrint (TPtxPdfAnnots_Annotation *pAnnotation)
	The annotation's visibility when printing If TRUE then the annotation is not present in a print output of the document.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetNoZoom (TPtxPdfAnnots_Annotation *pAnnotation)
	The annotation's scaling behavior If TRUE then the annotation's visual appearance does not scale with the zoom factor of a PDF viewer.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetNoRotate (TPtxPdfAnnots_Annotation *pAnnotation)
	The annotation's rotation behavior If TRUE then the annotation's visual appearance does not rotate with the rotation set in a PDF viewer.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetIdA (TPtxPdfAnnots_Annotation *pAnnotation, char *pBuffer, size_t nBufferSize)
	The annotation identifier A text string uniquely identifying it among all the annotations on its page. When creating annotations using the SDK, a unique ID is set automatically.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetIdW (TPtxPdfAnnots_Annotation *pAnnotation, WCHAR *pBuffer, size_t nBufferSize)
	The annotation identifier A text string uniquely identifying it among all the annotations on its page. When creating annotations using the SDK, a unique ID is set automatically.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_AnnotationType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Annotation_GetType (TPtxPdfAnnots_Annotation *pAnnotation)
	Get actual derived type of base type TPtxPdfAnnots_Annotation.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_AnnotationList_GetCount (TPtxPdfAnnots_AnnotationList *pAnnotationList)
	Get the number of elements in the list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_AnnotationList_Get (TPtxPdfAnnots_AnnotationList *pAnnotationList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_AnnotationList_Add (TPtxPdfAnnots_AnnotationList *pAnnotationList, TPtxPdfAnnots_Annotation *pAnnotation)
	Add an element to the end of the list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetCreationDate (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, TPtxSys_Date *pCreationDate)
	The date of creation.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetCreationDate (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const TPtxSys_Date *pCreationDate)
	The date of creation.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetModificationDate (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, TPtxSys_Date *pModificationDate)
	The date of last modification.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetModificationDate (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const TPtxSys_Date *pModificationDate)
	The date of last modification.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetLocked (TPtxPdfAnnots_MarkupInfo *pMarkupInfo)
	Whether the content can be modified This does not restrict the modification of other aspects of the annotation or its deletion.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetLocked (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, BOOL bLocked)
	Whether the content can be modified This does not restrict the modification of other aspects of the annotation or its deletion.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetAuthorA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
	The author.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetAuthorW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
	The author.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetAuthorA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szAuthor)
	The author.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetAuthorW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szAuthor)
	The author.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetSubjectA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
	The subject.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetSubjectW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
	The subject.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetSubjectA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szSubject)
	The subject.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetSubjectW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szSubject)
	The subject.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetContentA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
	The information content.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_GetContentW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
	The information content.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetContentA (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szContent)
	The information content.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfo_SetContentW (TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szContent)
	The information content.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfoList_GetCount (TPtxPdfAnnots_MarkupInfoList *pMarkupInfoList)
	Get the number of elements in the list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupInfoList_Get (TPtxPdfAnnots_MarkupInfoList *pMarkupInfoList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Popup_IsOpen (TPtxPdfAnnots_Popup *pPopup)
	The pop-up's visibility state.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Popup_GetBoundingBox (TPtxPdfAnnots_Popup *pPopup, TPtxGeomReal_Rectangle *pBoundingBox)
	The pop-up location.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupAnnotation_GetLocked (TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
	Whether the markup annotation can be modified This does not restrict modification of the markup annotation's content.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupAnnotation_GetInfo (TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
	The information content of this markup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfoList *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupAnnotation_GetReplies (TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
	The replies to this markup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupAnnotationType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_MarkupAnnotation_GetType (TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
	Get actual derived type of base type TPtxPdfAnnots_MarkupAnnotation.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_StickyNote_CreateA (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const char *szContent, TPtxPdfContent_Paint *pPaint)
	Create a sticky note annotation. The returned sticky note annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_StickyNote_CreateW (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const WCHAR *szContent, TPtxPdfContent_Paint *pPaint)
	Create a sticky note annotation. The returned sticky note annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_StickyNote_GetPaint (TPtxPdfAnnots_StickyNote *pStickyNote)
	The paint for the icon and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_StickyNote_GetPopup (TPtxPdfAnnots_StickyNote *pStickyNote)
	The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachment *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FileAttachment_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, TPtxPdf_FileReference *pAttachedFile, TPtxPdfContent_Paint *pPaint)
	Create a file attachment annotation. The returned file attachment annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachmentIcon PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FileAttachment_GetIcon (TPtxPdfAnnots_FileAttachment *pFileAttachment)
	The displayed icon.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FileAttachment_GetPaint (TPtxPdfAnnots_FileAttachment *pFileAttachment)
	The paint for the icon and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FileAttachment_GetAttachedFile (TPtxPdfAnnots_FileAttachment *pFileAttachment)
	The embedded file.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FileAttachment_GetPopup (TPtxPdfAnnots_FileAttachment *pFileAttachment)
	The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Stamp_GetPopup (TPtxPdfAnnots_Stamp *pStamp)
	The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Stamp_GetPopupPaint (TPtxPdfAnnots_Stamp *pStamp)
	The paint for the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StampType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Stamp_GetType (TPtxPdfAnnots_Stamp *pStamp)
	Get actual derived type of base type TPtxPdfAnnots_Stamp.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextStamp_CreateRawA (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType, const char *szText)
	Create a text stamp annotation. The width of the annotation is computed from the given stamp text. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextStamp_CreateRawW (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType, const WCHAR *szText)
	Create a text stamp annotation. The width of the annotation is computed from the given stamp text. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextStamp_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType)
	Create a text stamp annotation. The width of the annotation is computed based on the given iTextType. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStampType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextStamp_GetTextType (TPtxPdfAnnots_TextStamp *pTextStamp)
	The displayed text This defines a predefined text for this text stamp.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_CustomStamp *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_CustomStamp_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox)
	Create a custom stamp annotation. The returned custom stamp annotation's appearance has an empty content with size equal to the given pBoundingBox, and with coordinate origin located at the bottom left corner. Use a TPtxPdfContent_ContentGenerator to generate the stamp's content prior to adding the stamp annotation to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_CustomStamp_GetAppearance (TPtxPdfAnnots_CustomStamp *pCustomStamp)
	The custom stamp's visual appearance.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_CreateA (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const char *szContent, TPtxPdfContent_Paint *pPaint, TPtxPdfContent_Stroke *pStroke)
	Create a free-text annotation. The returned free-text annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_CreateW (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const WCHAR *szContent, TPtxPdfContent_Paint *pPaint, TPtxPdfContent_Stroke *pStroke)
	Create a free-text annotation. The returned free-text annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_GetFontSize (TPtxPdfAnnots_FreeText *pFreeText)
	The font size.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_SetFontSize (TPtxPdfAnnots_FreeText *pFreeText, double dFontSize)
	The font size.
PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_GetAlignment (TPtxPdfAnnots_FreeText *pFreeText)
	The text alignment.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_FreeText_GetPaint (TPtxPdfAnnots_FreeText *pFreeText)
	The paint for the text background and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_DrawingAnnotation_GetPaint (TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
	The paint for line stroking and for the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_DrawingAnnotation_GetPopup (TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
	The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_DrawingAnnotationType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_DrawingAnnotation_GetType (TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
	Get actual derived type of base type TPtxPdfAnnots_DrawingAnnotation.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pStart, const TPtxGeomReal_Point *pEnd, TPtxPdfContent_Stroke *pStroke)
	Create a line annotation. The returned line annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_GetStart (TPtxPdfAnnots_LineAnnotation *pLineAnnotation, TPtxGeomReal_Point *pStart)
	The line's starting point.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_GetEnd (TPtxPdfAnnots_LineAnnotation *pLineAnnotation, TPtxGeomReal_Point *pEnd)
	The line's ending point.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_GetStartStyle (TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
	The starting point's style.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_GetEndStyle (TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
	The ending point's style.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_LineAnnotation_GetLineEndingFill (TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
	The line ending filling paint This paint applies to both the starting end the ending point.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_InkAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_InkAnnotation_Create (TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke)
	Create a ink annotation. The returned ink annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolyLineAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolyLineAnnotation_Create (TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke)
	Create a poly-line annotation. The returned poly-line annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolyLineAnnotation_GetStartStyle (TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
	The starting point's style.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolyLineAnnotation_GetEndStyle (TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
	The ending point's style.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolyLineAnnotation_GetLineEndingFill (TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
	The line ending filling paint for both start and end.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolygonAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolygonAnnotation_Create (TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
	Create a polygon annotation. The returned polygon annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_PolygonAnnotation_GetFill (TPtxPdfAnnots_PolygonAnnotation *pPolygonAnnotation)
	The filling paint.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_RectangleAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_RectangleAnnotation_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
	Create a rectangle annotation. The returned rectangle annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_RectangleAnnotation_GetFill (TPtxPdfAnnots_RectangleAnnotation *pRectangleAnnotation)
	The filling paint.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_EllipseAnnotation *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_EllipseAnnotation_Create (TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
	Create an ellipse annotation. The returned ellipse annotation is not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_EllipseAnnotation_GetFill (TPtxPdfAnnots_EllipseAnnotation *pEllipseAnnotation)
	The filling paint.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextMarkup_GetPaint (TPtxPdfAnnots_TextMarkup *pTextMarkup)
	The paint the annotation and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextMarkup_GetPopup (TPtxPdfAnnots_TextMarkup *pTextMarkup)
	The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextMarkup_GetMarkupArea (TPtxPdfAnnots_TextMarkup *pTextMarkup)
	The markup area This list of TPtxGeomReal_Quadrilaterals defines the markup area on the page.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextMarkupType PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextMarkup_GetType (TPtxPdfAnnots_TextMarkup *pTextMarkup)
	Get actual derived type of base type TPtxPdfAnnots_TextMarkup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Highlight *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Highlight_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
	Create a new highlight with defined area The highlight area is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Underline *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Underline_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
	Create a new underline with defined area The area to be underlined is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StrikeThrough *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_StrikeThrough_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
	Create a new strike-through with defined area The area to be striked through is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Squiggly *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_Squiggly_CreateFromQuadrilaterals (TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
	Create a new squiggly underline with defined area The area to be underlined is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextInsert_GetPaint (TPtxPdfAnnots_TextInsert *pTextInsert)
	The paint for the annotation and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL	PtxPdfAnnots_TextInsert_GetPopup (TPtxPdfAnnots_TextInsert *pTextInsert)
	The pop-up.

Macro Definition Documentation

PDFTOOLS_TOOLBOX_CALL

#define PDFTOOLS_TOOLBOX_CALL

PtxPdfAnnots_Annotation_GetId

#define PtxPdfAnnots_Annotation_GetId   PtxPdfAnnots_Annotation_GetIdA

PtxPdfAnnots_FreeText_Create

#define PtxPdfAnnots_FreeText_Create   PtxPdfAnnots_FreeText_CreateA

PtxPdfAnnots_MarkupInfo_GetAuthor

#define PtxPdfAnnots_MarkupInfo_GetAuthor   PtxPdfAnnots_MarkupInfo_GetAuthorA

PtxPdfAnnots_MarkupInfo_GetContent

#define PtxPdfAnnots_MarkupInfo_GetContent   PtxPdfAnnots_MarkupInfo_GetContentA

PtxPdfAnnots_MarkupInfo_GetSubject

#define PtxPdfAnnots_MarkupInfo_GetSubject   PtxPdfAnnots_MarkupInfo_GetSubjectA

PtxPdfAnnots_MarkupInfo_SetAuthor

#define PtxPdfAnnots_MarkupInfo_SetAuthor   PtxPdfAnnots_MarkupInfo_SetAuthorA

PtxPdfAnnots_MarkupInfo_SetContent

#define PtxPdfAnnots_MarkupInfo_SetContent   PtxPdfAnnots_MarkupInfo_SetContentA

PtxPdfAnnots_MarkupInfo_SetSubject

#define PtxPdfAnnots_MarkupInfo_SetSubject   PtxPdfAnnots_MarkupInfo_SetSubjectA

PtxPdfAnnots_StickyNote_Create

#define PtxPdfAnnots_StickyNote_Create   PtxPdfAnnots_StickyNote_CreateA

PtxPdfAnnots_TextStamp_CreateRaw

#define PtxPdfAnnots_TextStamp_CreateRaw   PtxPdfAnnots_TextStamp_CreateRawA

Function Documentation

PtxPdfAnnots_Annotation_Copy()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_Copy	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfAnnots_Annotation *	pAnnotation )

Copy an annotation Copy an annotation object 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]	pAnnotation	the annotation to be copied to the pTargetDocument

Returns

the copied annotation, 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 pAnnotation is not associated with an input document
• ePtx_Error_IllegalArgument if the document associated with the pAnnotation 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

PtxPdfAnnots_Annotation_GetBoundingBox()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetBoundingBox	(	TPtxPdfAnnots_Annotation *	pAnnotation,
		TPtxGeomReal_Rectangle *	pBoundingBox )

The location on the page.

Parameters

[in,out]	pAnnotation	Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.
[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

PtxPdfAnnots_Annotation_GetHidden()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetHidden

(

TPtxPdfAnnots_Annotation *

pAnnotation

)

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

Parameters

[in,out]

pAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.

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

PtxPdfAnnots_Annotation_GetIdA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetIdA	(	TPtxPdfAnnots_Annotation *	pAnnotation,
		char *	pBuffer,
		size_t	nBufferSize )

The annotation identifier A text string uniquely identifying it among all the annotations on its page. When creating annotations using the SDK, a unique ID is set automatically.

Parameters

[in,out]	pAnnotation	Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_Annotation_GetIdW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetIdW	(	TPtxPdfAnnots_Annotation *	pAnnotation,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The annotation identifier A text string uniquely identifying it among all the annotations on its page. When creating annotations using the SDK, a unique ID is set automatically.

Parameters

[in,out]	pAnnotation	Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_Annotation_GetNoPrint()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoPrint

(

TPtxPdfAnnots_Annotation *

pAnnotation

)

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

Parameters

[in,out]

pAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.

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

PtxPdfAnnots_Annotation_GetNoRotate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoRotate

(

TPtxPdfAnnots_Annotation *

pAnnotation

)

The annotation's rotation behavior If TRUE then the annotation's visual appearance does not rotate with the rotation set in a PDF viewer.

Parameters

[in,out]

pAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.

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

PtxPdfAnnots_Annotation_GetNoZoom()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoZoom

(

TPtxPdfAnnots_Annotation *

pAnnotation

)

The annotation's scaling behavior If TRUE then the annotation's visual appearance does not scale with the zoom factor of a PDF viewer.

Parameters

[in,out]

pAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_Annotation.

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

PtxPdfAnnots_Annotation_GetType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_AnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetType

(

TPtxPdfAnnots_Annotation *

pAnnotation

)

Get actual derived type of base type TPtxPdfAnnots_Annotation.

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

Parameters

[in,out]

pAnnotation

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfAnnots_AnnotationType 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.

PtxPdfAnnots_AnnotationList_Add()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_Add	(	TPtxPdfAnnots_AnnotationList *	pAnnotationList,
		TPtxPdfAnnots_Annotation *	pAnnotation )

Add an element to the end of the list.

Parameters

[in,out]	pAnnotationList	Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList.
[in,out]	pAnnotation

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

PtxPdfAnnots_AnnotationList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_Get	(	TPtxPdfAnnots_AnnotationList *	pAnnotationList,
		int	iIndex )

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

Parameters

[in,out]	pAnnotationList	Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList.
[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

PtxPdfAnnots_AnnotationList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_GetCount

(

TPtxPdfAnnots_AnnotationList *

pAnnotationList

)

Get the number of elements in the list.

Parameters

[in,out]

pAnnotationList

Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList.

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

PtxPdfAnnots_CustomStamp_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_CustomStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_CustomStamp_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Rectangle *	pBoundingBox )

Create a custom stamp annotation. The returned custom stamp annotation's appearance has an empty content with size equal to the given pBoundingBox, and with coordinate origin located at the bottom left corner. Use a TPtxPdfContent_ContentGenerator to generate the stamp's content prior to adding the stamp annotation to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pBoundingBox	The location of the annotation on the page.

Returns

The newly created custom stamp annotation.

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

PtxPdfAnnots_CustomStamp_GetAppearance()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_CustomStamp_GetAppearance

(

TPtxPdfAnnots_CustomStamp *

pCustomStamp

)

The custom stamp's visual appearance.

Parameters

[in,out]

pCustomStamp

Acts as a handle to the native object of type TPtxPdfAnnots_CustomStamp.

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

PtxPdfAnnots_DrawingAnnotation_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPaint

(

TPtxPdfAnnots_DrawingAnnotation *

pDrawingAnnotation

)

The paint for line stroking and for the popup.

Parameters

[in,out]

pDrawingAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_DrawingAnnotation.

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 and the annotation's paint cannot be read

PtxPdfAnnots_DrawingAnnotation_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPopup

(

TPtxPdfAnnots_DrawingAnnotation *

pDrawingAnnotation

)

The pop-up.

Parameters

[in,out]

pDrawingAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_DrawingAnnotation.

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 if the object has already been closed

PtxPdfAnnots_DrawingAnnotation_GetType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_DrawingAnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetType

(

TPtxPdfAnnots_DrawingAnnotation *

pDrawingAnnotation

)

Get actual derived type of base type TPtxPdfAnnots_DrawingAnnotation.

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

Parameters

[in,out]

pDrawingAnnotation

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfAnnots_DrawingAnnotationType 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.

PtxPdfAnnots_EllipseAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_EllipseAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_EllipseAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Rectangle *	pBoundingBox,
		TPtxPdfContent_Stroke *	pStroke,
		TPtxPdfContent_Paint *	pFill )

Create an ellipse annotation. The returned ellipse annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pBoundingBox	The location on the page.
[in,out]	pStroke	The stroking parameters used for stroking the ellipse. The stroking paint is used as the annotation's main paint. If NULL then the ellipse is not stroked.
[in,out]	pFill	The paint used for filling the ellipse. If NULL then the ellipse is not filled.

Returns

The newly created ellipse annotation.

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 pStroke and pFill arguments are both NULL
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0
• ePtx_Error_IllegalArgument if the pFill has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pFill has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pFill argument is not associated with pTargetDocument

PtxPdfAnnots_EllipseAnnotation_GetFill()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_EllipseAnnotation_GetFill

(

TPtxPdfAnnots_EllipseAnnotation *

pEllipseAnnotation

)

The filling paint.

Parameters

[in,out]

pEllipseAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_EllipseAnnotation.

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

PtxPdfAnnots_FileAttachment_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachment *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		TPtxPdf_FileReference *	pAttachedFile,
		TPtxPdfContent_Paint *	pPaint )

Create a file attachment annotation. The returned file attachment annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated
[in]	pTopLeft	The location of the annotation's upper left corner on the page.
[in,out]	pAttachedFile	The file to be attached.
[in,out]	pPaint	This paint for the file attachment icon.

Returns

The newly created file attachment annotation.

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 color space of the pPaint argument is not a device color space
• ePtx_Error_IllegalArgument if the pPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pAttachedFile argument is not associated with the pTargetDocument
• ePtx_Error_Exists if the pAttachedFile argument is already used as a plain embedded file, an associated file, or in a file attachment.

PtxPdfAnnots_FileAttachment_GetAttachedFile()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetAttachedFile

(

TPtxPdfAnnots_FileAttachment *

pFileAttachment

)

The embedded file.

Parameters

[in,out]

pFileAttachment

Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment.

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

PtxPdfAnnots_FileAttachment_GetIcon()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachmentIcon PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetIcon

(

TPtxPdfAnnots_FileAttachment *

pFileAttachment

)

The displayed icon.

Parameters

[in,out]

pFileAttachment

Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_Corrupt the document is corrupt and the file reference cannot be read

PtxPdfAnnots_FileAttachment_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPaint

(

TPtxPdfAnnots_FileAttachment *

pFileAttachment

)

The paint for the icon and the popup.

Parameters

[in,out]

pFileAttachment

Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment.

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 and the annotation's paint cannot be read

PtxPdfAnnots_FileAttachment_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPopup

(

TPtxPdfAnnots_FileAttachment *

pFileAttachment

)

The pop-up.

Parameters

[in,out]

pFileAttachment

Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment.

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 if the object has already been closed

PtxPdfAnnots_FreeText_CreateA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_CreateA	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Rectangle *	pBoundingBox,
		const char *	szContent,
		TPtxPdfContent_Paint *	pPaint,
		TPtxPdfContent_Stroke *	pStroke )

Create a free-text annotation. The returned free-text annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pBoundingBox	The location on the page.
[in]	szContent	The text content.
[in,out]	pPaint	This paint used for the background of the free text annotation. If NULL, the background is transparent.
[in,out]	pStroke	The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation's main paint.

Returns

The newly created free text annotation.

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 pPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetDashPhase is other than 0

PtxPdfAnnots_FreeText_CreateW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_CreateW	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Rectangle *	pBoundingBox,
		const WCHAR *	szContent,
		TPtxPdfContent_Paint *	pPaint,
		TPtxPdfContent_Stroke *	pStroke )

Create a free-text annotation. The returned free-text annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pBoundingBox	The location on the page.
[in]	szContent	The text content.
[in,out]	pPaint	This paint used for the background of the free text annotation. If NULL, the background is transparent.
[in,out]	pStroke	The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation's main paint.

Returns

The newly created free text annotation.

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 pPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetDashPhase is other than 0

PtxPdfAnnots_FreeText_GetAlignment()

PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetAlignment

(

TPtxPdfAnnots_FreeText *

pFreeText

)

The text alignment.

Parameters

[in,out]

pFreeText

Acts as a handle to the native object of type TPtxPdfAnnots_FreeText.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_FreeText_GetFontSize()

PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetFontSize

(

TPtxPdfAnnots_FreeText *

pFreeText

)

The font size.

Default value: 12.

Note: the font size has no effect when rich text is used

Parameters

[in,out]

pFreeText

Acts as a handle to the native object of type TPtxPdfAnnots_FreeText.

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. 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 smaller than 0.0

PtxPdfAnnots_FreeText_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetPaint

(

TPtxPdfAnnots_FreeText *

pFreeText

)

The paint for the text background and the popup.

Parameters

[in,out]

pFreeText

Acts as a handle to the native object of type TPtxPdfAnnots_FreeText.

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 and the annotation's paint cannot be read

PtxPdfAnnots_FreeText_SetFontSize()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_SetFontSize	(	TPtxPdfAnnots_FreeText *	pFreeText,
		double	dFontSize )

The font size.

Default value: 12.

Note: the font size has no effect when rich text is used

Parameters

[in,out]	pFreeText	Acts as a handle to the native object of type TPtxPdfAnnots_FreeText.
[in]	dFontSize	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 smaller than 0.0

PtxPdfAnnots_Highlight_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Highlight *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Highlight_CreateFromQuadrilaterals	(	TPtxPdf_Document *	pTargetDocument,
		TPtxGeomReal_QuadrilateralList *	pMarkupArea,
		TPtxPdfContent_Paint *	pPaint )

Create a new highlight with defined area The highlight area is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The document in which the links is used
[in,out]	pMarkupArea	The area on the page to be highlighted.
[in,out]	pPaint	The highlight paint

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 pMarkupArea is empty
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pPaint argument has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint argument has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal

PtxPdfAnnots_InkAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_InkAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_InkAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfContent_Path *	pPath,
		TPtxPdfContent_Stroke *	pStroke )

Create a ink annotation. The returned ink annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in,out]	pPath	The path of the free-hand drawing.
[in,out]	pStroke	The stroking parameters used for stroking the line. The stroking paint is used as the annotation's main paint.

Returns

The newly created ink annotation.

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 pPath argument has not been constructed with a TPtxPdfContent_PathGenerator
• ePtx_Error_IllegalArgument if the pTargetDocument's conformance is not PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pPath argument contains rectangle operations
• ePtx_Error_UnsupportedFeature if the pTargetDocument's conformance is PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's dash array is not empty
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with the pTargetDocument

PtxPdfAnnots_LineAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pStart,
		const TPtxGeomReal_Point *	pEnd,
		TPtxPdfContent_Stroke *	pStroke )

Create a line annotation. The returned line annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pStart	The line's start point.
[in]	pEnd	The line's end point.
[in,out]	pStroke	The stroking parameters used for stroking the line. The stroking paint is used as the annotation's main paint.

Returns

The newly created line annotation.

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 has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument is read-only
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0

PtxPdfAnnots_LineAnnotation_GetEnd()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEnd	(	TPtxPdfAnnots_LineAnnotation *	pLineAnnotation,
		TPtxGeomReal_Point *	pEnd )

The line's ending point.

Parameters

[in,out]	pLineAnnotation	Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation.
[out]	pEnd	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

PtxPdfAnnots_LineAnnotation_GetEndStyle()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEndStyle

(

TPtxPdfAnnots_LineAnnotation *

pLineAnnotation

)

The ending point's style.

Parameters

[in,out]

pLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_LineAnnotation_GetLineEndingFill()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetLineEndingFill

(

TPtxPdfAnnots_LineAnnotation *

pLineAnnotation

)

The line ending filling paint This paint applies to both the starting end the ending point.

Parameters

[in,out]

pLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation.

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

PtxPdfAnnots_LineAnnotation_GetStart()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStart	(	TPtxPdfAnnots_LineAnnotation *	pLineAnnotation,
		TPtxGeomReal_Point *	pStart )

The line's starting point.

Parameters

[in,out]	pLineAnnotation	Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation.
[out]	pStart	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

PtxPdfAnnots_LineAnnotation_GetStartStyle()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStartStyle

(

TPtxPdfAnnots_LineAnnotation *

pLineAnnotation

)

The starting point's style.

Parameters

[in,out]

pLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_MarkupAnnotation_GetInfo()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetInfo

(

TPtxPdfAnnots_MarkupAnnotation *

pMarkupAnnotation

)

The information content of this markup.

Parameters

[in,out]

pMarkupAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation.

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

PtxPdfAnnots_MarkupAnnotation_GetLocked()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetLocked

(

TPtxPdfAnnots_MarkupAnnotation *

pMarkupAnnotation

)

Whether the markup annotation can be modified This does not restrict modification of the markup annotation's content.

Parameters

[in,out]

pMarkupAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation.

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

PtxPdfAnnots_MarkupAnnotation_GetReplies()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfoList *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetReplies

(

TPtxPdfAnnots_MarkupAnnotation *

pMarkupAnnotation

)

The replies to this markup.

Parameters

[in,out]

pMarkupAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation.

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

PtxPdfAnnots_MarkupAnnotation_GetType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupAnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetType

(

TPtxPdfAnnots_MarkupAnnotation *

pMarkupAnnotation

)

Get actual derived type of base type TPtxPdfAnnots_MarkupAnnotation.

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

Parameters

[in,out]

pMarkupAnnotation

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfAnnots_MarkupAnnotationType 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.

PtxPdfAnnots_MarkupInfo_GetAuthorA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		char *	pBuffer,
		size_t	nBufferSize )

The author.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_GetAuthorW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The author.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_GetContentA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		char *	pBuffer,
		size_t	nBufferSize )

The information content.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_GetContentW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The information content.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_GetCreationDate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetCreationDate	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		TPtxSys_Date *	pCreationDate )

The date of creation.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[out]	pCreationDate	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

PtxPdfAnnots_MarkupInfo_GetLocked()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetLocked

(

TPtxPdfAnnots_MarkupInfo *

pMarkupInfo

)

Whether the content can be modified This does not restrict the modification of other aspects of the annotation or its deletion.

Parameters

[in,out]

pMarkupInfo

Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.

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
• 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

PtxPdfAnnots_MarkupInfo_GetModificationDate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetModificationDate	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		TPtxSys_Date *	pModificationDate )

The date of last modification.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[out]	pModificationDate	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

PtxPdfAnnots_MarkupInfo_GetSubjectA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		char *	pBuffer,
		size_t	nBufferSize )

The subject.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_GetSubjectW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The subject.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[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 either an error occurred or the returned buffer 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 0 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

PtxPdfAnnots_MarkupInfo_SetAuthorA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const char *	szAuthor )

The author.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szAuthor	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

PtxPdfAnnots_MarkupInfo_SetAuthorW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const WCHAR *	szAuthor )

The author.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szAuthor	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

PtxPdfAnnots_MarkupInfo_SetContentA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const char *	szContent )

The information content.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szContent	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

PtxPdfAnnots_MarkupInfo_SetContentW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const WCHAR *	szContent )

The information content.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szContent	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

PtxPdfAnnots_MarkupInfo_SetCreationDate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetCreationDate	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const TPtxSys_Date *	pCreationDate )

The date of creation.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	pCreationDate	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

PtxPdfAnnots_MarkupInfo_SetLocked()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetLocked	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		BOOL	bLocked )

Whether the content can be modified This does not restrict the modification of other aspects of the annotation or its deletion.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	bLocked	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

PtxPdfAnnots_MarkupInfo_SetModificationDate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetModificationDate	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const TPtxSys_Date *	pModificationDate )

The date of last modification.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	pModificationDate	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

PtxPdfAnnots_MarkupInfo_SetSubjectA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectA	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const char *	szSubject )

The subject.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szSubject	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

PtxPdfAnnots_MarkupInfo_SetSubjectW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectW	(	TPtxPdfAnnots_MarkupInfo *	pMarkupInfo,
		const WCHAR *	szSubject )

The subject.

Parameters

[in,out]	pMarkupInfo	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo.
[in]	szSubject	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

PtxPdfAnnots_MarkupInfoList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_Get	(	TPtxPdfAnnots_MarkupInfoList *	pMarkupInfoList,
		int	iIndex )

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

Parameters

[in,out]	pMarkupInfoList	Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfoList.
[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

PtxPdfAnnots_MarkupInfoList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_GetCount

(

TPtxPdfAnnots_MarkupInfoList *

pMarkupInfoList

)

Get the number of elements in the list.

Parameters

[in,out]

pMarkupInfoList

Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfoList.

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

PtxPdfAnnots_PolygonAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolygonAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolygonAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfContent_Path *	pPath,
		TPtxPdfContent_Stroke *	pStroke,
		TPtxPdfContent_Paint *	pFill )

Create a polygon annotation. The returned polygon annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in,out]	pPath	The path of the polygon.
[in,out]	pStroke	The stroking parameters used for stroking the polygon. The stroking paint is used as the annotation's main paint. If NULL then the polygon is not filled.
[in,out]	pFill	The paint used for filling the polygon. If NULL then the polygon is not filled.

Returns

The newly created polygon annotation.

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 pPath argument has not been constructed with a TPtxPdfContent_PathGenerator
• ePtx_Error_IllegalArgument if the pTargetDocument's conformance is not PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pPath argument contains close-subpath or rectangle operations
• ePtx_Error_UnsupportedFeature if the pTargetDocument's conformance is PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pStroke and pFill arguments are both NULL
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0
• ePtx_Error_IllegalArgument if the pFill has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pFill has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pFill argument is not associated with the pTargetDocument
• ePtx_Error_Conformance if the explicitly requested PDF conformance is smaller than PDF 1.5

PtxPdfAnnots_PolygonAnnotation_GetFill()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolygonAnnotation_GetFill

(

TPtxPdfAnnots_PolygonAnnotation *

pPolygonAnnotation

)

The filling paint.

Parameters

[in,out]

pPolygonAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_PolygonAnnotation.

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

PtxPdfAnnots_PolyLineAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolyLineAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfContent_Path *	pPath,
		TPtxPdfContent_Stroke *	pStroke )

Create a poly-line annotation. The returned poly-line annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in,out]	pPath	The path of the poly line.
[in,out]	pStroke	The stroking parameters used for stroking the poly-line. The stroking paint is used as the annotation's main paint.

Returns

The newly created poly-line annotation.

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 pTargetDocument's conformance is not PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pPath argument contains close-subpath or rectangle operations
• ePtx_Error_UnsupportedFeature if the pTargetDocument's conformance is PDF 2.0 and the pPath argument contains curve-to operations
• ePtx_Error_IllegalArgument if the pPath argument has not been constructed with a TPtxPdfContent_PathGenerator
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0
• ePtx_Error_Conformance if the explicitly requested PDF conformance is smaller than PDF 1.5

PtxPdfAnnots_PolyLineAnnotation_GetEndStyle()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetEndStyle

(

TPtxPdfAnnots_PolyLineAnnotation *

pPolyLineAnnotation

)

The ending point's style.

Parameters

[in,out]

pPolyLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_PolyLineAnnotation_GetLineEndingFill()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetLineEndingFill

(

TPtxPdfAnnots_PolyLineAnnotation *

pPolyLineAnnotation

)

The line ending filling paint for both start and end.

Parameters

[in,out]

pPolyLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation.

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

PtxPdfAnnots_PolyLineAnnotation_GetStartStyle()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetStartStyle

(

TPtxPdfAnnots_PolyLineAnnotation *

pPolyLineAnnotation

)

The starting point's style.

Parameters

[in,out]

pPolyLineAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_Popup_GetBoundingBox()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Popup_GetBoundingBox	(	TPtxPdfAnnots_Popup *	pPopup,
		TPtxGeomReal_Rectangle *	pBoundingBox )

The pop-up location.

Parameters

[in,out]	pPopup	Acts as a handle to the native object of type TPtxPdfAnnots_Popup.
[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

PtxPdfAnnots_Popup_IsOpen()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Popup_IsOpen

(

TPtxPdfAnnots_Popup *

pPopup

)

The pop-up's visibility state.

Parameters

[in,out]

pPopup

Acts as a handle to the native object of type TPtxPdfAnnots_Popup.

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

PtxPdfAnnots_RectangleAnnotation_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_RectangleAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_RectangleAnnotation_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Rectangle *	pBoundingBox,
		TPtxPdfContent_Stroke *	pStroke,
		TPtxPdfContent_Paint *	pFill )

Create a rectangle annotation. The returned rectangle annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pBoundingBox	The location on the page.
[in,out]	pStroke	The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation's main paint. If NULL then the rectangle is not stroked.
[in,out]	pFill	The paint used for filling the rectangle. If NULL then the rectangle is not filled.

Returns

The newly created rectangle annotation.

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 is NULL
• ePtx_Error_IllegalArgument if the pTargetDocument is read-only
• ePtx_Error_IllegalArgument if the pStroke and pFill arguments are both NULL
• ePtx_Error_IllegalArgument if the pStroke argument is not associated with the pTargetDocument
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pStroke's PtxPdfContent_Stroke_GetPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineCapStyle is other than ePtxPdfContent_LineCapStyle_Butt
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetLineJoinStyle is other than ePtxPdfContent_LineJoinStyle_Miter
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetMiterLimit is other than 10
• ePtx_Error_IllegalArgument if the pStroke argument's PtxPdfContent_Stroke_GetDashPhase is other than 0
• ePtx_Error_IllegalArgument if the pFill has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pFill has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pFill argument is not associated with the pTargetDocument

PtxPdfAnnots_RectangleAnnotation_GetFill()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_RectangleAnnotation_GetFill

(

TPtxPdfAnnots_RectangleAnnotation *

pRectangleAnnotation

)

The filling paint.

Parameters

[in,out]

pRectangleAnnotation

Acts as a handle to the native object of type TPtxPdfAnnots_RectangleAnnotation.

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

PtxPdfAnnots_Squiggly_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Squiggly *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Squiggly_CreateFromQuadrilaterals	(	TPtxPdf_Document *	pTargetDocument,
		TPtxGeomReal_QuadrilateralList *	pMarkupArea,
		TPtxPdfContent_Paint *	pPaint )

Create a new squiggly underline with defined area The area to be underlined is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The document in which the links is used
[in,out]	pMarkupArea	The area on the page to be underlined.
[in,out]	pPaint	The paint used for drawing the squiggly underline

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 pMarkupArea is empty
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pPaint argument has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint argument has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal

PtxPdfAnnots_Stamp_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopup

(

TPtxPdfAnnots_Stamp *

pStamp

)

The pop-up.

Parameters

[in,out]

pStamp

Acts as a handle to the native object of type TPtxPdfAnnots_Stamp.

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 if the object has already been closed

PtxPdfAnnots_Stamp_GetPopupPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopupPaint

(

TPtxPdfAnnots_Stamp *

pStamp

)

The paint for the popup.

Parameters

[in,out]

pStamp

Acts as a handle to the native object of type TPtxPdfAnnots_Stamp.

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 and the annotation's paint cannot be read

PtxPdfAnnots_Stamp_GetType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StampType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetType

(

TPtxPdfAnnots_Stamp *

pStamp

)

Get actual derived type of base type TPtxPdfAnnots_Stamp.

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

Parameters

[in,out]

pStamp

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfAnnots_StampType 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.

PtxPdfAnnots_StickyNote_CreateA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_CreateA	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		const char *	szContent,
		TPtxPdfContent_Paint *	pPaint )

Create a sticky note annotation. The returned sticky note annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated
[in]	pTopLeft	The location of the annotation's upper left corner on the page
[in]	szContent	The text content
[in,out]	pPaint	The paint for the sticky note icon.

Returns

The newly created sticky note annotation

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 color space of the pPaint argument is not a device color space
• ePtx_Error_IllegalArgument if the pPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with the pTargetDocument

PtxPdfAnnots_StickyNote_CreateW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_CreateW	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		const WCHAR *	szContent,
		TPtxPdfContent_Paint *	pPaint )

Create a sticky note annotation. The returned sticky note annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated
[in]	pTopLeft	The location of the annotation's upper left corner on the page
[in]	szContent	The text content
[in,out]	pPaint	The paint for the sticky note icon.

Returns

The newly created sticky note annotation

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 color space of the pPaint argument is not a device color space
• ePtx_Error_IllegalArgument if the pPaint has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with the pTargetDocument

PtxPdfAnnots_StickyNote_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPaint

(

TPtxPdfAnnots_StickyNote *

pStickyNote

)

The paint for the icon and the popup.

Parameters

[in,out]

pStickyNote

Acts as a handle to the native object of type TPtxPdfAnnots_StickyNote.

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 and the annotation's paint cannot be read

PtxPdfAnnots_StickyNote_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPopup

(

TPtxPdfAnnots_StickyNote *

pStickyNote

)

The pop-up.

Parameters

[in,out]

pStickyNote

Acts as a handle to the native object of type TPtxPdfAnnots_StickyNote.

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 if the object has already been closed

PtxPdfAnnots_StrikeThrough_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StrikeThrough *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StrikeThrough_CreateFromQuadrilaterals	(	TPtxPdf_Document *	pTargetDocument,
		TPtxGeomReal_QuadrilateralList *	pMarkupArea,
		TPtxPdfContent_Paint *	pPaint )

Create a new strike-through with defined area The area to be striked through is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The document in which the links is used
[in,out]	pMarkupArea	The area on the page to be striked through.
[in,out]	pPaint	The paint used for drawing the strike through

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 pMarkupArea is empty
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pPaint argument has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint argument has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal

PtxPdfAnnots_TextInsert_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPaint

(

TPtxPdfAnnots_TextInsert *

pTextInsert

)

The paint for the annotation and the popup.

Parameters

[in,out]

pTextInsert

Acts as a handle to the native object of type TPtxPdfAnnots_TextInsert.

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 and the annotation's paint cannot be read

PtxPdfAnnots_TextInsert_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPopup

(

TPtxPdfAnnots_TextInsert *

pTextInsert

)

The pop-up.

Parameters

[in,out]

pTextInsert

Acts as a handle to the native object of type TPtxPdfAnnots_TextInsert.

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 if the object has already been closed

PtxPdfAnnots_TextMarkup_GetMarkupArea()

PDFTOOLS_TOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetMarkupArea

(

TPtxPdfAnnots_TextMarkup *

pTextMarkup

)

The markup area This list of TPtxGeomReal_Quadrilaterals defines the markup area on the page.

Parameters

[in,out]

pTextMarkup

Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup.

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

PtxPdfAnnots_TextMarkup_GetPaint()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPaint

(

TPtxPdfAnnots_TextMarkup *

pTextMarkup

)

The paint the annotation and the popup.

Parameters

[in,out]

pTextMarkup

Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup.

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 and the annotation's paint cannot be read

PtxPdfAnnots_TextMarkup_GetPopup()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPopup

(

TPtxPdfAnnots_TextMarkup *

pTextMarkup

)

The pop-up.

Parameters

[in,out]

pTextMarkup

Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup.

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 if the object has already been closed

PtxPdfAnnots_TextMarkup_GetType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextMarkupType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetType

(

TPtxPdfAnnots_TextMarkup *

pTextMarkup

)

Get actual derived type of base type TPtxPdfAnnots_TextMarkup.

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

Parameters

[in,out]

pTextMarkup

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfAnnots_TextMarkupType 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.

PtxPdfAnnots_TextStamp_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_Create	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		const double *	pHeight,
		TPtxPdfAnnots_TextStampType	iTextType )

Create a text stamp annotation. The width of the annotation is computed based on the given iTextType. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pTopLeft	The location of the annotation's upper left corner on the page.
[in]	pHeight	The height of the annotation.
[in]	iTextType	The text stamp type.

Returns

The newly created text stamp annotation.

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 iTextType argument is ePtxPdfAnnots_TextStampType_CustomStampText

PtxPdfAnnots_TextStamp_CreateRawA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_CreateRawA	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		const double *	pHeight,
		TPtxPdfAnnots_TextStampType	iTextType,
		const char *	szText )

Create a text stamp annotation. The width of the annotation is computed from the given stamp text. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pTopLeft	The location of the annotation's upper left corner on the page.
[in]	pHeight	The height of the annotation.
[in]	iTextType	The text stamp type.
[in]	szText	The text to be shown in this stamp.

Returns

The newly created text stamp annotation.

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 iTextType argument is ePtxPdfAnnots_TextStampType_CustomStampText
• ePtx_Error_IllegalArgument if the szText argument is empty

Deprecated

Deprecated in Version 1.0. Use static method TextStamp.Create instead.

PtxPdfAnnots_TextStamp_CreateRawW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_CreateRawW	(	TPtxPdf_Document *	pTargetDocument,
		const TPtxGeomReal_Point *	pTopLeft,
		const double *	pHeight,
		TPtxPdfAnnots_TextStampType	iTextType,
		const WCHAR *	szText )

Create a text stamp annotation. The width of the annotation is computed from the given stamp text. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The output document with which the returned object is associated.
[in]	pTopLeft	The location of the annotation's upper left corner on the page.
[in]	pHeight	The height of the annotation.
[in]	iTextType	The text stamp type.
[in]	szText	The text to be shown in this stamp.

Returns

The newly created text stamp annotation.

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 iTextType argument is ePtxPdfAnnots_TextStampType_CustomStampText
• ePtx_Error_IllegalArgument if the szText argument is empty

Deprecated

Deprecated in Version 1.0. Use static method TextStamp.Create instead.

PtxPdfAnnots_TextStamp_GetTextType()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStampType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_GetTextType

(

TPtxPdfAnnots_TextStamp *

pTextStamp

)

The displayed text This defines a predefined text for this text stamp.

Parameters

[in,out]

pTextStamp

Acts as a handle to the native object of type TPtxPdfAnnots_TextStamp.

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. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfAnnots_Underline_CreateFromQuadrilaterals()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Underline *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Underline_CreateFromQuadrilaterals	(	TPtxPdf_Document *	pTargetDocument,
		TPtxGeomReal_QuadrilateralList *	pMarkupArea,
		TPtxPdfContent_Paint *	pPaint )

Create a new underline with defined area The area to be underlined is defined by the given pMarkupArea. The returned object is associated with the pTargetDocument but not yet part of any page. It can be added to a page's list of annotations.

Parameters

[in,out]	pTargetDocument	The document in which the links is used
[in,out]	pMarkupArea	The area on the page to be underlined.
[in,out]	pPaint	The paint used for drawing the underline

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 pMarkupArea is empty
• ePtx_Error_IllegalArgument if the pPaint argument is not associated with pTargetDocument
• ePtx_Error_IllegalArgument if the pPaint argument has a PtxPdfContent_Paint_GetColorSpace other than a device color space
• ePtx_Error_IllegalArgument if the pPaint argument has a non-NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal