|
PDF Toolbox
|
Go to the source code of this file.
| #define PDFTOOLBOX_CALL |
| #define PtxPdfAnnots_Annotation_GetId PtxPdfAnnots_Annotation_GetIdA |
| #define PtxPdfAnnots_FreeText_Create PtxPdfAnnots_FreeText_CreateA |
| #define PtxPdfAnnots_MarkupInfo_GetAuthor PtxPdfAnnots_MarkupInfo_GetAuthorA |
| #define PtxPdfAnnots_MarkupInfo_GetContent PtxPdfAnnots_MarkupInfo_GetContentA |
| #define PtxPdfAnnots_MarkupInfo_GetSubject PtxPdfAnnots_MarkupInfo_GetSubjectA |
| #define PtxPdfAnnots_MarkupInfo_SetAuthor PtxPdfAnnots_MarkupInfo_SetAuthorA |
| #define PtxPdfAnnots_MarkupInfo_SetContent PtxPdfAnnots_MarkupInfo_SetContentA |
| #define PtxPdfAnnots_MarkupInfo_SetSubject PtxPdfAnnots_MarkupInfo_SetSubjectA |
| #define PtxPdfAnnots_StickyNote_Create PtxPdfAnnots_StickyNote_CreateA |
| #define PtxPdfAnnots_TextStamp_CreateRaw PtxPdfAnnots_TextStamp_CreateRawA |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLBOX_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.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in,out] | pAnnotation | the annotation to be copied to the pTargetDocument |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_Annotation_GetBoundingBox | ( | TPtxPdfAnnots_Annotation * | pAnnotation, |
| TPtxGeomReal_Rectangle * | pBoundingBox ) |
The location on the page.
| [in,out] | pAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_Annotation. |
| [out] | pBoundingBox | Retrieved value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_Annotation. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_Annotation. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_Annotation. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_Annotation. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_AnnotationType PDFTOOLBOX_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.
| [in,out] | pAnnotation | Acts as a handle to a native object. |
0 in case of an error.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_AnnotationList_Add | ( | TPtxPdfAnnots_AnnotationList * | pAnnotationList, |
| TPtxPdfAnnots_Annotation * | pAnnotation ) |
Add an element to the end of the list.
| [in,out] | pAnnotationList | Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList. |
| [in,out] | pAnnotation |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLBOX_CALL PtxPdfAnnots_AnnotationList_Get | ( | TPtxPdfAnnots_AnnotationList * | pAnnotationList, |
| int | iIndex ) |
Returns the element at the specified position in the given list.
| [in,out] | pAnnotationList | Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList. |
| [in] | iIndex |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfAnnots_AnnotationList_GetCount | ( | TPtxPdfAnnots_AnnotationList * | pAnnotationList | ) |
Get the number of elements in the list.
| [in,out] | pAnnotationList | Acts as a handle to the native object of type TPtxPdfAnnots_AnnotationList. |
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_CustomStamp *PDFTOOLBOX_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.
| [in,out] | pTargetDocument | The output document with which the returned object is associated. |
| [in] | pBoundingBox | The location of the annotation on the page. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLBOX_CALL PtxPdfAnnots_CustomStamp_GetAppearance | ( | TPtxPdfAnnots_CustomStamp * | pCustomStamp | ) |
The custom stamp's visual appearance.
| [in,out] | pCustomStamp | Acts as a handle to the native object of type TPtxPdfAnnots_CustomStamp. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPaint | ( | TPtxPdfAnnots_DrawingAnnotation * | pDrawingAnnotation | ) |
The paint for line stroking and for the popup.
| [in,out] | pDrawingAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_DrawingAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPopup | ( | TPtxPdfAnnots_DrawingAnnotation * | pDrawingAnnotation | ) |
The pop-up.
| [in,out] | pDrawingAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_DrawingAnnotation. |
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.
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:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_DrawingAnnotationType PDFTOOLBOX_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.
| [in,out] | pDrawingAnnotation | Acts as a handle to a native object. |
0 in case of an error.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLBOX_EXPORT TPtxPdfAnnots_EllipseAnnotation *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_NormalNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_EllipseAnnotation_GetFill | ( | TPtxPdfAnnots_EllipseAnnotation * | pEllipseAnnotation | ) |
The filling paint.
| [in,out] | pEllipseAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_EllipseAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_FileAttachment *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetAttachedFile | ( | TPtxPdfAnnots_FileAttachment * | pFileAttachment | ) |
The embedded file.
| [in,out] | pFileAttachment | Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_FileAttachmentIcon PDFTOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetIcon | ( | TPtxPdfAnnots_FileAttachment * | pFileAttachment | ) |
The displayed icon.
| [in,out] | pFileAttachment | Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPaint | ( | TPtxPdfAnnots_FileAttachment * | pFileAttachment | ) |
The paint for the icon and the popup.
| [in,out] | pFileAttachment | Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPopup | ( | TPtxPdfAnnots_FileAttachment * | pFileAttachment | ) |
The pop-up.
| [in,out] | pFileAttachment | Acts as a handle to the native object of type TPtxPdfAnnots_FileAttachment. |
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.
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:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_NormalNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_NormalNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLBOX_CALL PtxPdfAnnots_FreeText_GetAlignment | ( | TPtxPdfAnnots_FreeText * | pFreeText | ) |
The text alignment.
| [in,out] | pFreeText | Acts as a handle to the native object of type TPtxPdfAnnots_FreeText. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT double PDFTOOLBOX_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
| [in,out] | pFreeText | Acts as a handle to the native object of type TPtxPdfAnnots_FreeText. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_FreeText_GetPaint | ( | TPtxPdfAnnots_FreeText * | pFreeText | ) |
The paint for the text background and the popup.
| [in,out] | pFreeText | Acts as a handle to the native object of type TPtxPdfAnnots_FreeText. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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
| [in,out] | pFreeText | Acts as a handle to the native object of type TPtxPdfAnnots_FreeText. |
| [in] | dFontSize | Set value. |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Highlight *PDFTOOLBOX_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.
| [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 |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal | PDFTOOLBOX_EXPORT TPtxPdfAnnots_InkAnnotation *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfAnnots_LineAnnotation *PDFTOOLBOX_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.
| [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. |
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.
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:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEnd | ( | TPtxPdfAnnots_LineAnnotation * | pLineAnnotation, |
| TPtxGeomReal_Point * | pEnd ) |
The line's ending point.
| [in,out] | pLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation. |
| [out] | pEnd | Retrieved value. |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEndStyle | ( | TPtxPdfAnnots_LineAnnotation * | pLineAnnotation | ) |
The ending point's style.
| [in,out] | pLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetLineEndingFill | ( | TPtxPdfAnnots_LineAnnotation * | pLineAnnotation | ) |
The line ending filling paint This paint applies to both the starting end the ending point.
| [in,out] | pLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStart | ( | TPtxPdfAnnots_LineAnnotation * | pLineAnnotation, |
| TPtxGeomReal_Point * | pStart ) |
The line's starting point.
| [in,out] | pLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation. |
| [out] | pStart | Retrieved value. |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStartStyle | ( | TPtxPdfAnnots_LineAnnotation * | pLineAnnotation | ) |
The starting point's style.
| [in,out] | pLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_LineAnnotation. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetInfo | ( | TPtxPdfAnnots_MarkupAnnotation * | pMarkupAnnotation | ) |
The information content of this markup.
| [in,out] | pMarkupAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pMarkupAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfoList *PDFTOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetReplies | ( | TPtxPdfAnnots_MarkupAnnotation * | pMarkupAnnotation | ) |
The replies to this markup.
| [in,out] | pMarkupAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_MarkupAnnotationType PDFTOOLBOX_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.
| [in,out] | pMarkupAnnotation | Acts as a handle to a native object. |
0 in case of an error.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The author.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The author.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The information content.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The information content.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetCreationDate | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| TPtxSys_Date * | pCreationDate ) |
The date of creation.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [out] | pCreationDate | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetModificationDate | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| TPtxSys_Date * | pModificationDate ) |
The date of last modification.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [out] | pModificationDate | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The subject.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The subject.
| [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. |
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. 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:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const char * | szAuthor ) |
The author.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szAuthor | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const WCHAR * | szAuthor ) |
The author.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szAuthor | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const char * | szContent ) |
The information content.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szContent | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const WCHAR * | szContent ) |
The information content.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szContent | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetCreationDate | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const TPtxSys_Date * | pCreationDate ) |
The date of creation.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | pCreationDate | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | bLocked | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetModificationDate | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const TPtxSys_Date * | pModificationDate ) |
The date of last modification.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | pModificationDate | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectA | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const char * | szSubject ) |
The subject.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szSubject | Set value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectW | ( | TPtxPdfAnnots_MarkupInfo * | pMarkupInfo, |
| const WCHAR * | szSubject ) |
The subject.
| [in,out] | pMarkupInfo | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfo. |
| [in] | szSubject | Set value. |
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_Get | ( | TPtxPdfAnnots_MarkupInfoList * | pMarkupInfoList, |
| int | iIndex ) |
Returns the element at the specified position in the given list.
| [in,out] | pMarkupInfoList | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfoList. |
| [in] | iIndex |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_GetCount | ( | TPtxPdfAnnots_MarkupInfoList * | pMarkupInfoList | ) |
Get the number of elements in the list.
| [in,out] | pMarkupInfoList | Acts as a handle to the native object of type TPtxPdfAnnots_MarkupInfoList. |
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_PolygonAnnotation *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_NormalNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_PolygonAnnotation_GetFill | ( | TPtxPdfAnnots_PolygonAnnotation * | pPolygonAnnotation | ) |
The filling paint.
| [in,out] | pPolygonAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_PolygonAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_PolyLineAnnotation *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetEndStyle | ( | TPtxPdfAnnots_PolyLineAnnotation * | pPolyLineAnnotation | ) |
The ending point's style.
| [in,out] | pPolyLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetLineEndingFill | ( | TPtxPdfAnnots_PolyLineAnnotation * | pPolyLineAnnotation | ) |
The line ending filling paint for both start and end.
| [in,out] | pPolyLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetStartStyle | ( | TPtxPdfAnnots_PolyLineAnnotation * | pPolyLineAnnotation | ) |
The starting point's style.
| [in,out] | pPolyLineAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_PolyLineAnnotation. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_Popup_GetBoundingBox | ( | TPtxPdfAnnots_Popup * | pPopup, |
| TPtxGeomReal_Rectangle * | pBoundingBox ) |
The pop-up location.
| [in,out] | pPopup | Acts as a handle to the native object of type TPtxPdfAnnots_Popup. |
| [out] | pBoundingBox | Retrieved value. |
| PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfAnnots_Popup_IsOpen | ( | TPtxPdfAnnots_Popup * | pPopup | ) |
The pop-up's visibility state.
| [in,out] | pPopup | Acts as a handle to the native object of type TPtxPdfAnnots_Popup. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLBOX_EXPORT TPtxPdfAnnots_RectangleAnnotation *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLNULLNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_NormalNULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_RectangleAnnotation_GetFill | ( | TPtxPdfAnnots_RectangleAnnotation * | pRectangleAnnotation | ) |
The filling paint.
| [in,out] | pRectangleAnnotation | Acts as a handle to the native object of type TPtxPdfAnnots_RectangleAnnotation. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Squiggly *PDFTOOLBOX_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.
| [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 |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal | PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopup | ( | TPtxPdfAnnots_Stamp * | pStamp | ) |
The pop-up.
| [in,out] | pStamp | Acts as a handle to the native object of type TPtxPdfAnnots_Stamp. |
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.
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:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopupPaint | ( | TPtxPdfAnnots_Stamp * | pStamp | ) |
The paint for the popup.
| [in,out] | pStamp | Acts as a handle to the native object of type TPtxPdfAnnots_Stamp. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_StampType PDFTOOLBOX_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.
| [in,out] | pStamp | Acts as a handle to a native object. |
0 in case of an error.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPaint | ( | TPtxPdfAnnots_StickyNote * | pStickyNote | ) |
The paint for the icon and the popup.
| [in,out] | pStickyNote | Acts as a handle to the native object of type TPtxPdfAnnots_StickyNote. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPopup | ( | TPtxPdfAnnots_StickyNote * | pStickyNote | ) |
The pop-up.
| [in,out] | pStickyNote | Acts as a handle to the native object of type TPtxPdfAnnots_StickyNote. |
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.
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:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_StrikeThrough *PDFTOOLBOX_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.
| [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 |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal | PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPaint | ( | TPtxPdfAnnots_TextInsert * | pTextInsert | ) |
The paint for the annotation and the popup.
| [in,out] | pTextInsert | Acts as a handle to the native object of type TPtxPdfAnnots_TextInsert. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPopup | ( | TPtxPdfAnnots_TextInsert * | pTextInsert | ) |
The pop-up.
| [in,out] | pTextInsert | Acts as a handle to the native object of type TPtxPdfAnnots_TextInsert. |
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.
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:| PDFTOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetMarkupArea | ( | TPtxPdfAnnots_TextMarkup * | pTextMarkup | ) |
The markup area This list of TPtxGeomReal_Quadrilaterals defines the markup area on the page.
| [in,out] | pTextMarkup | Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPaint | ( | TPtxPdfAnnots_TextMarkup * | pTextMarkup | ) |
The paint the annotation and the popup.
| [in,out] | pTextMarkup | Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPopup | ( | TPtxPdfAnnots_TextMarkup * | pTextMarkup | ) |
The pop-up.
| [in,out] | pTextMarkup | Acts as a handle to the native object of type TPtxPdfAnnots_TextMarkup. |
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.
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:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_TextMarkupType PDFTOOLBOX_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.
| [in,out] | pTextMarkup | Acts as a handle to a native object. |
0 in case of an error.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLBOX_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.
| [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. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_TextStampType PDFTOOLBOX_CALL PtxPdfAnnots_TextStamp_GetTextType | ( | TPtxPdfAnnots_TextStamp * | pTextStamp | ) |
The displayed text This defines a predefined text for this text stamp.
| [in,out] | pTextStamp | Acts as a handle to the native object of type TPtxPdfAnnots_TextStamp. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLBOX_EXPORT TPtxPdfAnnots_Underline *PDFTOOLBOX_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.
| [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 |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULLPtxPdfContent_Paint_GetTransparency with PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal 1.10.0