|
PDF Toolbox
|
Go to the source code of this file.
| #define PDFTOOLS_TOOLBOX_CALL |
| #define PtxPdfContent_ContentGenerator_TagAs PtxPdfContent_ContentGenerator_TagAsA |
| #define PtxPdfContent_Font_CreateFromSystem PtxPdfContent_Font_CreateFromSystemA |
| #define PtxPdfContent_Font_GetBaseFont PtxPdfContent_Font_GetBaseFontA |
| #define PtxPdfContent_Glyph_GetText PtxPdfContent_Glyph_GetTextA |
| #define PtxPdfContent_OptionalContentMembership_GetExpression PtxPdfContent_OptionalContentMembership_GetExpressionA |
| #define PtxPdfContent_TextFragment_GetText PtxPdfContent_TextFragment_GetTextA |
| #define PtxPdfContent_TextGenerator_GetWidth PtxPdfContent_TextGenerator_GetWidthA |
| #define PtxPdfContent_TextGenerator_Show PtxPdfContent_TextGenerator_ShowA |
| #define PtxPdfContent_TextGenerator_ShowLine PtxPdfContent_TextGenerator_ShowLineA |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ColorSpace_Copy | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_ColorSpace * | pColorSpace ) |
Copy a color space Copy a color space 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] | pColorSpace | a color space of a different document |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ColorSpace_CreateProcessColorSpace | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_ProcessColorSpaceType | iType ) |
Get the canonical grayscale, RGB, or CMYK color space. Depending on the PDF/A compliance and the output intent, this is either a device color space (TPtxPdfContent_DeviceGrayColorSpace, TPtxPdfContent_DeviceRgbColorSpace, TPtxPdfContent_DeviceCmykColorSpace), a calibrated color space (TPtxPdfContent_CalibratedGrayColorSpace, TPtxPdfContent_CalibratedRgbColorSpace), or an ICC-based color space (4-channel TPtxPdfContent_IccBasedColorSpace). The returned color space object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | iType | the color space 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:| PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ColorSpace_GetComponentCount | ( | TPtxPdfContent_ColorSpace * | pColorSpace | ) |
the number of components in the color space.
| [in,out] | pColorSpace | Acts as a handle to the native object of type TPtxPdfContent_ColorSpace. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ColorSpaceType PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ColorSpace_GetType | ( | TPtxPdfContent_ColorSpace * | pColorSpace | ) |
Get actual derived type of base type TPtxPdfContent_ColorSpace.
This function is invoked prior to downcasting to ascertain the derived object type.
| [in,out] | pColorSpace | 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. | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentElement *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_Copy | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_ContentElement * | pContentElement ) |
Copy a content element 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] | pContentElement | a content element of a different document |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_GetBoundingBox | ( | TPtxPdfContent_ContentElement * | pContentElement, |
| TPtxGeomReal_Rectangle * | pBoundingBox ) |
the bounding box This is a rectangle that encompasses all parts of an element.
| [in,out] | pContentElement | Acts as a handle to the native object of type TPtxPdfContent_ContentElement. |
| [out] | pBoundingBox | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_OptionalContentMembership *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_GetOcm | ( | TPtxPdfContent_ContentElement * | pContentElement | ) |
Defines the visibility of the content element depending on the optional content groups (OCGs).
| [in,out] | pContentElement | Acts as a handle to the native object of type TPtxPdfContent_ContentElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_GetTransform | ( | TPtxPdfContent_ContentElement * | pContentElement, |
| TPtxGeomReal_AffineTransform * | pTransform ) |
the transform to be applied to the alignment rectangle Use this transform matrix to compute the actual location of the element's alignment rectangle.
| [in,out] | pContentElement | Acts as a handle to the native object of type TPtxPdfContent_ContentElement. |
| [out] | pTransform | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentElementType PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_GetType | ( | TPtxPdfContent_ContentElement * | pContentElement | ) |
Get actual derived type of base type TPtxPdfContent_ContentElement.
This function is invoked prior to downcasting to ascertain the derived object type.
| [in,out] | pContentElement | 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. | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentElement_SetTransform | ( | TPtxPdfContent_ContentElement * | pContentElement, |
| const TPtxGeomReal_AffineTransform * | pTransform ) |
the transform to be applied to the alignment rectangle Use this transform matrix to compute the actual location of the element's alignment rectangle.
| [in,out] | pContentElement | Acts as a handle to the native object of type TPtxPdfContent_ContentElement. |
| [in] | pTransform | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentExtractorIterator *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractor_GetIterator | ( | TPtxPdfContent_ContentExtractor * | pContentExtractor | ) |
Get an iterator for this enumerable.
| [in,out] | pContentExtractor | Acts as a handle to the native object of type TPtxPdfContent_ContentExtractor. |
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:
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_UngroupingSelection PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractor_GetUngrouping | ( | TPtxPdfContent_ContentExtractor * | pContentExtractor | ) |
Configures the extractor's behavior regarding the selection of groups to be un-grouped. Default value: ePtxPdfContent_UngroupingSelection_None.
| [in,out] | pContentExtractor | Acts as a handle to the native object of type TPtxPdfContent_ContentExtractor. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentExtractor *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractor_New | ( | TPtxPdfContent_Content * | pContent | ) |
Create a new content extractor.
| [in,out] | pContent | the content object of a page or group |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractor_SetUngrouping | ( | TPtxPdfContent_ContentExtractor * | pContentExtractor, |
| TPtxPdfContent_UngroupingSelection | iUngrouping ) |
Configures the extractor's behavior regarding the selection of groups to be un-grouped. Default value: ePtxPdfContent_UngroupingSelection_None.
| [in,out] | pContentExtractor | Acts as a handle to the native object of type TPtxPdfContent_ContentExtractor. |
| [in] | iUngrouping | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentElement *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractorIterator_GetValue | ( | TPtxPdfContent_ContentExtractorIterator * | pContentExtractorIterator | ) |
Get the current element or NULLif no elements are left.
| [in,out] | pContentExtractorIterator | Acts as a handle to the native object of type TPtxPdfContent_ContentExtractorIterator. |
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:
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentExtractorIterator_MoveNext | ( | TPtxPdfContent_ContentExtractorIterator * | pContentExtractorIterator | ) |
Move the iterator to the next element.
| [in,out] | pContentExtractorIterator | Acts as a handle to the native object of type TPtxPdfContent_ContentExtractorIterator. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_AppendContentElement | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_ContentElement * | pContentElement ) |
Paint a content element.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pContentElement | the content element to be painted |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_ClipWithPath | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Path * | pPath, | ||
| TPtxPdfContent_InsideRule | iInsideRule ) |
Intersect clip path with path. Update the current clip path by intersecting with the given path.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pPath | the path to intersect with the current clip path |
| [in] | iInsideRule | the inside rule of the path argument |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_ClipWithText | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Text * | pText ) |
Intersect clip path with text. Update the current clip path by intersecting with the given text.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pText | the text to intersect with the current clip path |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_Close | ( | TPtxPdfContent_ContentGenerator * | pObject | ) |
Close object.
Close disposable objects by invoking this function.
| [in] | pObject | Disposable object. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ContentGenerator *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_New | ( | TPtxPdfContent_Content * | pContent, |
| BOOL | bPrepend ) |
Create a new content generator for appending or prepending to the content of a group.
| [in,out] | pContent | the content object of a page or group |
| [in] | bPrepend | TRUE for prepending to the content (apply content to background of page), FALSE for appending (apply content to foreground of 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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_PaintGroup | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Group * | pGroup, | ||
| const TPtxGeomReal_Rectangle * | pTargetRect, | ||
| TPtxPdfContent_Transparency * | pTransparency ) |
Paint a group.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pGroup | the group to be painted |
| [in] | pTargetRect | the target rectangle in the current coordinate system. If targetRect is NULL, a default rectangle [0, 0, width, height] is used, where width and height are the dimensions of the given pGroup's Size |
| [in,out] | pTransparency | the transparency to be used when painting the group. If Transparency is NULL, then the group is painted opaquely. |
NULL and has properties PtxPdfContent_Transparency_GetAlpha other than 1.0 or PtxPdfContent_Transparency_GetBlendMode other than ePtxPdfContent_BlendMode_Normal, and the explicitly specified conformance does not support transparency (PDF/A-1, PDF 1.0 - 1.3). | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_PaintImage | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Image * | pImage, | ||
| const TPtxGeomReal_Rectangle * | pTargetRect ) |
Paint an image.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pImage | the image to be painted |
| [in] | pTargetRect | the target rectangle in the current coordinate system. If targetRect is NULL, the unit rectangle [0, 0, 1, 1] is used. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_PaintImageMask | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_ImageMask * | pImageMask, | ||
| const TPtxGeomReal_Rectangle * | pTargetRect, | ||
| TPtxPdfContent_Paint * | pPaint ) |
Paint an image (stencil) mask.
An image mask is a monochrome image, in which each sample is specified by a single bit. However, instead of being painted in opaque black and white, the image mask is treated as a stencil mask that is partly opaque and partly transparent. Sample values in the image do not represent black and white pixels; rather, they designate places on the content that should either be marked with the given paint or masked out (not marked at all). Areas that are masked out retain their former content.
The effect is like applying paint in the current color through a cut-out stencil, which allows the paint to reach the page in some places and masks it out in others.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pImageMask | the image (stencil) mask |
| [in] | pTargetRect | the target rectangle in the current coordinate system. If targetRect is NULL, the unit rectangle [0, 0, 1, 1] is used. |
| [in,out] | pPaint | the paint for filling marked pixels |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_PaintPath | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Path * | pPath, | ||
| TPtxPdfContent_Fill * | pFill, | ||
| TPtxPdfContent_Stroke * | pStroke ) |
Paint a path. The path is first filled and then stroked The blend mode for filling and stroking must be the same.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pPath | the path to be painted |
| [in,out] | pFill | the fill properties or NULL if the path should not be filled |
| [in,out] | pStroke | the stroke properties or NULL if the path should not be stroked |
NULL.NULL.| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_PaintText | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfContent_Text * | pText ) |
Paint text.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pText | the text to be painted |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_Restore | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator | ) |
Restore the graphics state. The most recently saved state is restored and removed from the graphics state stack. The following properties are affected:
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_Save | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator | ) |
Save the current graphics state The graphics state is stored on the graphics state stack. The following properties are affected:
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_StopTagging | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator | ) |
Stop tagging content.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_TagAsA | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfStructure_Node * | pNode, | ||
| const char * | szLanguage ) |
Associate content created following this call with the supplied element of the document structure tree.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pNode | the tag to be applied to the marked content |
| [in] | szLanguage | The language code that specifies the language of the tagged content. Specifying the language is highly recommended for PDF/A level A conformance. The codes are defined in BCP 47 and ISO 3166:2013 and can be obtained from the Internet Engineering Task Force and the International Organization for Standardization. If no code is set, the language will be specified as unknown. Examples:
|
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_TagAsW | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| TPtxPdfStructure_Node * | pNode, | ||
| const WCHAR * | szLanguage ) |
Associate content created following this call with the supplied element of the document structure tree.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in,out] | pNode | the tag to be applied to the marked content |
| [in] | szLanguage | The language code that specifies the language of the tagged content. Specifying the language is highly recommended for PDF/A level A conformance. The codes are defined in BCP 47 and ISO 3166:2013 and can be obtained from the Internet Engineering Task Force and the International Organization for Standardization. If no code is set, the language will be specified as unknown. Examples:
|
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ContentGenerator_Transform | ( | TPtxPdfContent_ContentGenerator * | pContentGenerator, |
| const TPtxGeomReal_AffineTransform * | pTransform ) |
Modify the current transform matrix by concatenating the specified matrix.
| [in,out] | pContentGenerator | Acts as a handle to the native object of type TPtxPdfContent_ContentGenerator. |
| [in] | pTransform | the transform that is applied to the current transform |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_InsideRule PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Fill_GetInsideRule | ( | TPtxPdfContent_Fill * | pFill | ) |
| [in,out] | pFill | Acts as a handle to the native object of type TPtxPdfContent_Fill. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Fill_GetPaint | ( | TPtxPdfContent_Fill * | pFill | ) |
| [in,out] | pFill | Acts as a handle to the native object of type TPtxPdfContent_Fill. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Fill *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Fill_New | ( | TPtxPdfContent_Paint * | pPaint | ) |
| [in,out] | pPaint |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Fill_SetInsideRule | ( | TPtxPdfContent_Fill * | pFill, |
| TPtxPdfContent_InsideRule | iInsideRule ) |
| [in,out] | pFill | Acts as a handle to the native object of type TPtxPdfContent_Fill. |
| [in] | iInsideRule | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Fill_SetPaint | ( | TPtxPdfContent_Fill * | pFill, |
| TPtxPdfContent_Paint * | pPaint ) |
| [in,out] | pFill | Acts as a handle to the native object of type TPtxPdfContent_Fill. |
| [in,out] | pPaint | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Font *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| const TPtxSys_StreamDescriptor * | pStreamDesc, | ||
| BOOL | bEmbedded ) |
Create a new font object from font file data. Supported formats are:
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | pStreamDesc | the font file data stream |
| [in] | bEmbedded | TRUE if the font shall be embedded in the document. Note that this parameter must be TRUE for PDF/A documents. |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Font *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_CreateFromSystemA | ( | TPtxPdf_Document * | pTargetDocument, |
| const char * | szFamily, | ||
| const char * | szStyle, | ||
| BOOL | bEmbedded ) |
Create a new font object from an installed font. The returned font object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | szFamily | the font family name (e.g. "Arial") |
| [in] | szStyle | the font style (e.g. "Bold") |
| [in] | bEmbedded | TRUE if the font shall be embedded in the document. Note that this parameter must be TRUE for PDF/A documents. |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Font *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_CreateFromSystemW | ( | TPtxPdf_Document * | pTargetDocument, |
| const WCHAR * | szFamily, | ||
| const WCHAR * | szStyle, | ||
| BOOL | bEmbedded ) |
Create a new font object from an installed font. The returned font object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | szFamily | the font family name (e.g. "Arial") |
| [in] | szStyle | the font style (e.g. "Bold") |
| [in] | bEmbedded | TRUE if the font shall be embedded in the document. Note that this parameter must be TRUE for PDF/A documents. |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetAscent | ( | TPtxPdfContent_Font * | pFont | ) |
the ascent of the font. The maximum height above the baseline reached by glyphs in this font, excluding the height of glyphs for accented characters.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetBaseFontA | ( | TPtxPdfContent_Font * | pFont, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
the PostScript name of the font
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetBaseFontW | ( | TPtxPdfContent_Font * | pFont, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
the PostScript name of the font
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetCapHeight | ( | TPtxPdfContent_Font * | pFont | ) |
the cap height of the font. The vertical coordinate of the top of flat capital letters, measured from the baseline.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetCharacterWidth | ( | TPtxPdfContent_Font * | pFont, |
| int | iCharacter ) |
the width of a single glyph.
The width of a unicode character (in pt) relative to a font size of 1 pt.
If an error occurs (because the font or the owning document has already been closed) this method returns 0. But a return value of 0 is not generally an indication for failure.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
| [in] | iCharacter | the unicode character code. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetDescent | ( | TPtxPdfContent_Font * | pFont | ) |
the descent of the font. The maximum depth below the baseline reached by glyphs in this font. The value is a negative number.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetItalicAngle | ( | TPtxPdfContent_Font * | pFont | ) |
the italic angle of the font. The angle is expressed in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font. (For example, the 9-o’clock position is 90 degrees, and the 3-o’clock position is –90 degrees.) The value is negative for fonts that slope to the right, as almost all italic fonts do.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetLeading | ( | TPtxPdfContent_Font * | pFont, |
| double * | pLeading ) |
the leading of the font.
The vertical distance between two adjacent base lines in multiline text.
This is a recomended value when generating several lines of text. If the font does not define this value, NULL is returned.
Note that PtxPdfContent_TextGenerator_New uses a fixed value of 1.2 instead of this property to initialize the PtxPdfContent_TextGenerator_SetLeading in order to maintain backward compatibility with earlier versions.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
| [out] | pLeading | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_GetWeight | ( | TPtxPdfContent_Font * | pFont, |
| TPtxPdfContent_FontWeight * | pWeight ) |
the visual weight of the font. Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font. If the font does not define this value, NULL is returned.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
| [out] | pWeight | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Font_IsEmbedded | ( | TPtxPdfContent_Font * | pFont | ) |
Specifies whether the font is embedded.
| [in,out] | pFont | Acts as a handle to the native object of type TPtxPdfContent_Font. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Glyph_GetPosition | ( | TPtxPdfContent_Glyph * | pGlyph, |
| TPtxGeomReal_Point * | pPosition ) |
glyph position
This is the position of the glyph within its TPtxPdfContent_TextFragment. To find the point on the page this position has to be transformed with PtxPdfContent_TextFragment_GetTransform.
The extent of the glyph with respect to its position depends on the text fragment's PtxPdfContent_TextFragment_GetWritingMode. In ePtxPdfContent_WritingMode_Horizontal writing mode, the glyph's position is at the left of the glyph on the height of the base line. In ePtxPdfContent_WritingMode_Vertical writing mode, the glyph's position is at the middle of the glyph's horizontal extent, vertically at the top.
| [in,out] | pGlyph | Acts as a handle to the native object of type TPtxPdfContent_Glyph. |
| [out] | pPosition | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Glyph_GetTextA | ( | TPtxPdfContent_Glyph * | pGlyph, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
glyph text This is the glyph's associated text.
| [in,out] | pGlyph | Acts as a handle to the native object of type TPtxPdfContent_Glyph. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Glyph_GetTextW | ( | TPtxPdfContent_Glyph * | pGlyph, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
glyph text This is the glyph's associated text.
| [in,out] | pGlyph | Acts as a handle to the native object of type TPtxPdfContent_Glyph. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Glyph_GetWidth | ( | TPtxPdfContent_Glyph * | pGlyph | ) |
glyph width This is the width of the glyph.
| [in,out] | pGlyph | Acts as a handle to the native object of type TPtxPdfContent_Glyph. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_CopyFromPage | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdf_Page * | pPage, | ||
| TPtxPdf_PageCopyOptions * | pOptions ) |
Create a group object from a page.
From a given page in an input document, create a group object in the given target document. The returned object is associated with the target document but not yet part of it.
A group that contains interactive elements can be painted once only. Interactive elements are annotations, group fields, outlines or logical structure information. If a group needs to be painted multiple times, interactive elements can be flattened or the group can be copied multiple times from the page.
There are some interactive elements such as form fields or text annotations that cannot be rotated. So if you plan to rotate the group, it is recommended to flatten form fields and annotations.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in,out] | pPage | a page of a different document |
| [in,out] | pOptions | the copy options |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| const TPtxGeomReal_Size * | pSize ) |
Create an empty group object. The returned group object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | pSize | the size of the group |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Content *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_GetContent | ( | TPtxPdfContent_Group * | pGroup | ) |
the group content. If the group is writable, the content object can be used to apply new content on the group.
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_GetIsolated | ( | TPtxPdfContent_Group * | pGroup | ) |
the transparency isolation behavior
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_GetKnockout | ( | TPtxPdfContent_Group * | pGroup | ) |
the transparency knockout behavior
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_GetSize | ( | TPtxPdfContent_Group * | pGroup, |
| TPtxGeomReal_Size * | pSize ) |
The size of the group.
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
| [out] | pSize | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_SetIsolated | ( | TPtxPdfContent_Group * | pGroup, |
| BOOL | bIsolated ) |
the transparency isolation behavior
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
| [in] | bIsolated | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Group_SetKnockout | ( | TPtxPdfContent_Group * | pGroup, |
| BOOL | bKnockout ) |
the transparency knockout behavior
| [in,out] | pGroup | Acts as a handle to the native object of type TPtxPdfContent_Group. |
| [in] | bKnockout | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_GroupElement *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_GroupElement_CopyWithoutContent | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_GroupElement * | pGroupElement ) |
Copy a group element without copying its content Create a new group element, taking a given group element as a template. The newly created group has the same properties, such as geometric transform, clipping, and soft mask, but it's content is empty. 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] | pGroupElement | a group element of a different document |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_GroupElement_GetGroup | ( | TPtxPdfContent_GroupElement * | pGroupElement | ) |
This group element's group object.
| [in,out] | pGroupElement | Acts as a handle to the native object of type TPtxPdfContent_GroupElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_IccBasedColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_IccBasedColorSpace_Copy | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_IccBasedColorSpace * | pColorSpace ) |
Copy an ICC-based color space Copy an ICC-based color space 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] | pColorSpace | an ICC-based color space of a different document |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_IccBasedColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_IccBasedColorSpace_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| const TPtxSys_StreamDescriptor * | pProfile ) |
Create an new ICC-based color space from an ICC color profile. The returned color space object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | pProfile | the color profile data stream |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Image *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| const TPtxSys_StreamDescriptor * | pStreamDesc ) |
Create an image object from image data. Supported formats are:
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | pStreamDesc | the image data stream |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_Extract | ( | TPtxPdfContent_Image * | pImage, |
| const TPtxSys_StreamDescriptor * | pStreamDesc, | ||
| const TPtxPdfContent_ImageType * | pImageType ) |
Extract embedded image from PDF.
Facilitate the extraction of images from a specified page within a PDF, outputting them in the pImageType format.
By default, the method determines the format of the extracted image based on the embedded image data present within the PDF. Users can ascertain the default image format through PtxPdfContent_Image_GetDefaultImageType. It's important to note that not all image types or conversion processes are universally supported, hence adhering to the default TPtxPdfContent_ImageType is advisable for optimal compatibility.
Key considerations include:
This method is designed to efficiently retrieve images without their page-specific modifications, ensuring a straightforward extraction process.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
| [in,out] | pStreamDesc | The image data stream. |
| [in] | pImageType | The desired image type of the extracted image stream. If the embedded image data cannot be directly extracted to the chosen ImageType, the data is first recompressed and then extracted to the chosen ImageType. In this case, extraction is slower and there can be some loss of image quality. The default image type can be retrieved by calling PtxPdfContent_Image_GetDefaultImageType. |
| PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_GetBitsPerComponent | ( | TPtxPdfContent_Image * | pImage | ) |
the number of bits per component. The number of bits used to represent each color component. Only a single value may be specified; the number of bits is the same for all color components. Valid values are 1, 2, 4, and 8.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_GetColorSpace | ( | TPtxPdfContent_Image * | pImage | ) |
the color space in which image samples are specified.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ImageType PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_GetDefaultImageType | ( | TPtxPdfContent_Image * | pImage | ) |
Default extracted image type. The default image type that will be extracted, based on the way that the image data is compressed and stored in the PDF file. The type of the output image is ePtxPdfContent_ImageType_Jpeg for embedded JPEG and JPEG2000 images. In all other cases the image type will be ePtxPdfContent_ImageType_Tiff.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
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:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_GetSamples | ( | TPtxPdfContent_Image * | pImage, |
| unsigned char * | pBuffer, | ||
| size_t | nBufferSize ) |
The raw content of the image.
The samples (pixels) are given in order, top to bottom, left to right. Each sample is given component by component. There is no padding between components or samples, except that each row of sample data begins on a byte boundary. If the number of data bits per row is not a multiple of 8, the end of the row is padded with extra bits to fill out the last byte. Padding bits should be ignored.
Most often, each component is 8 bits, so there's no packing/unpacking or alignment/padding. Components with 2 or 4 bits are very rare.
If the image is compressed, it will be decompressed in order to get the samples. For very large images, this may take some time.
When setting samples, the original compression type of the image does not change. Compression from the raw samples typically takes significantly longer than decompression. Therefore, setting for large images might be perceived as slow. None of the image parameters can be changed, so when setting samples, the size of the array must match that of the original image.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
| [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 array pBuffer. |
pBuffer. -1 if there is an error. 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_GetSize | ( | TPtxPdfContent_Image * | pImage, |
| TPtxGeomInt_Size * | pSize ) |
The size of the image in samples. Samples are often also called pixels.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
| [out] | pSize | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_Redact | ( | TPtxPdfContent_Image * | pImage, |
| const TPtxGeomReal_Rectangle * | pRect ) |
Redact rectangular part of the image Redacts a part of the image specified by a rectangle, by changing the content of the image. This is not an annotation, the image data is changed and there will be no way to get the original data from the image itself. The content is changed by setting all pixels to the same color. This color, in general, is black, but that depends on the color space of the image.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
| [in] | pRect | Defines rectangular part of the image which is to be redacted. If the rectangle is not completely within the image boundaries, only the part that is within the boundaries will be redacted. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Image_SetSamples | ( | TPtxPdfContent_Image * | pImage, |
| const unsigned char * | pSamples, | ||
| size_t | nSampless ) |
The raw content of the image.
The samples (pixels) are given in order, top to bottom, left to right. Each sample is given component by component. There is no padding between components or samples, except that each row of sample data begins on a byte boundary. If the number of data bits per row is not a multiple of 8, the end of the row is padded with extra bits to fill out the last byte. Padding bits should be ignored.
Most often, each component is 8 bits, so there's no packing/unpacking or alignment/padding. Components with 2 or 4 bits are very rare.
If the image is compressed, it will be decompressed in order to get the samples. For very large images, this may take some time.
When setting samples, the original compression type of the image does not change. Compression from the raw samples typically takes significantly longer than decompression. Therefore, setting for large images might be perceived as slow. None of the image parameters can be changed, so when setting samples, the size of the array must match that of the original image.
| [in,out] | pImage | Acts as a handle to the native object of type TPtxPdfContent_Image. |
| [in] | pSamples | Set value. |
| [in] | nSampless | Size of the array pSamples. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Image *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageElement_GetImage | ( | TPtxPdfContent_ImageElement * | pImageElement | ) |
This element's image.
| [in,out] | pImageElement | Acts as a handle to the native object of type TPtxPdfContent_ImageElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ImageMask *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageMask_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| const TPtxSys_StreamDescriptor * | pStreamDesc ) |
Create an image mask object from image data. Supported formats are:
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in] | pStreamDesc | the image data stream |
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:NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageMask_Extract | ( | TPtxPdfContent_ImageMask * | pImageMask, |
| const TPtxSys_StreamDescriptor * | pStreamDesc, | ||
| const TPtxPdfContent_ImageType * | pImageType ) |
Extract image mask from PDF.
Facilitate the extraction of image masks from a specified page within a PDF, outputting them in the pImageType format.
By default pImageType takes the value ePtxPdfContent_ImageType_Tiff.
Key considerations include:
This method is designed to efficiently retrieve image masks without their page-specific modifications, ensuring a straightforward extraction process.
| [in,out] | pImageMask | Acts as a handle to the native object of type TPtxPdfContent_ImageMask. |
| [in,out] | pStreamDesc | The image mask data stream. |
| [in] | pImageType |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageMask_GetSize | ( | TPtxPdfContent_ImageMask * | pImageMask, |
| TPtxGeomInt_Size * | pSize ) |
The size of the image mask in samples.
| [in,out] | pImageMask | Acts as a handle to the native object of type TPtxPdfContent_ImageMask. |
| [out] | pSize | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ImageMask *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageMaskElement_GetImageMask | ( | TPtxPdfContent_ImageMaskElement * | pImageMaskElement | ) |
This element's image mask.
| [in,out] | pImageMaskElement | Acts as a handle to the native object of type TPtxPdfContent_ImageMaskElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_ImageMaskElement_GetPaint | ( | TPtxPdfContent_ImageMaskElement * | pImageMaskElement | ) |
The paint used to draw the image mask.
| [in,out] | pImageMaskElement | Acts as a handle to the native object of type TPtxPdfContent_ImageMaskElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_OptionalContentMembership_DependsOn | ( | TPtxPdfContent_OptionalContentMembership * | pOptionalContentMembership, |
| TPtxPdf_OptionalContentGroup * | pOcg ) |
Checks if the content element depends on a given TPtxPdf_OptionalContentGroup.
| [in,out] | pOptionalContentMembership | Acts as a handle to the native object of type TPtxPdfContent_OptionalContentMembership. |
| [in,out] | pOcg | The optional content group to be checked. |
| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_OptionalContentMembership_GetExpressionA | ( | TPtxPdfContent_OptionalContentMembership * | pOptionalContentMembership, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The content element visibility function.
Optional content membership expression defines the visibility as a boolean function of OCG indices in C syntax. The OCG index represents the position of the element in the OCG list which can be retrieved by using PtxPdf_Document_GetOptionalContentGroups. Example: "1 || 2" means that the content element is visible if either OCG 1 or OCG 2 is ON.
Alternatively, the evaluated expression can be fetched via PtxPdfContent_OptionalContentMembership_IsVisible.
| [in,out] | pOptionalContentMembership | Acts as a handle to the native object of type TPtxPdfContent_OptionalContentMembership. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_OptionalContentMembership_GetExpressionW | ( | TPtxPdfContent_OptionalContentMembership * | pOptionalContentMembership, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The content element visibility function.
Optional content membership expression defines the visibility as a boolean function of OCG indices in C syntax. The OCG index represents the position of the element in the OCG list which can be retrieved by using PtxPdf_Document_GetOptionalContentGroups. Example: "1 || 2" means that the content element is visible if either OCG 1 or OCG 2 is ON.
Alternatively, the evaluated expression can be fetched via PtxPdfContent_OptionalContentMembership_IsVisible.
| [in,out] | pOptionalContentMembership | Acts as a handle to the native object of type TPtxPdfContent_OptionalContentMembership. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_OptionalContentMembership_IsVisible | ( | TPtxPdfContent_OptionalContentMembership * | pOptionalContentMembership | ) |
The element visibility. TRUE if the element is visible in the default configuration or PtxPdf_Document_GetOptionalContentGroups is empty. FALSE, otherwise.
| [in,out] | pOptionalContentMembership | Acts as a handle to the native object of type TPtxPdfContent_OptionalContentMembership. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Paint_Create | ( | TPtxPdf_Document * | pTargetDocument, |
| TPtxPdfContent_ColorSpace * | pColorSpace, | ||
| const double * | pColor, | ||
| size_t | nColors, | ||
| TPtxPdfContent_Transparency * | pTransparency ) |
Create an new paint. Transparency is supported by PDF 1.4 or higher and by PDF/A-2 or higher. The returned paint object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
| [in,out] | pColorSpace | the color space of the paint |
| [in] | pColor | the color components |
| [in] | nColors | Size of the array pColor. |
| [in,out] | pTransparency | the transparency parameters. Use NULL to create an opaque 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:NULL and PtxPdfContent_Transparency_GetAlpha of pTransparency is not 1.0 and the explicitly specified conformance does not support transparency (PDF/A-1, PDF 1.0 - 1.3).NULL and PtxPdfContent_Transparency_GetBlendMode is not ePtxPdfContent_BlendMode_Normal and the explicitly specified conformance does not support transparency (PDF/A-1, PDF 1.0 - 1.3).| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Paint_GetColor | ( | TPtxPdfContent_Paint * | pPaint, |
| double * | pBuffer, | ||
| size_t | nBufferSize ) |
The color values of this paint.
| [in,out] | pPaint | Acts as a handle to the native object of type TPtxPdfContent_Paint. |
| [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 array pBuffer. |
pBuffer. -1 if there is an error. 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_ColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Paint_GetColorSpace | ( | TPtxPdfContent_Paint * | pPaint | ) |
The color space of this paint.
| [in,out] | pPaint | Acts as a handle to the native object of type TPtxPdfContent_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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Transparency *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Paint_GetTransparency | ( | TPtxPdfContent_Paint * | pPaint | ) |
The transparency parameters of this paint or NULL if this paint is opaque.
| [in,out] | pPaint | Acts as a handle to the native object of type TPtxPdfContent_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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_PathIterator *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Path_GetIterator | ( | TPtxPdfContent_Path * | pPath | ) |
Get an iterator for this enumerable.
| [in,out] | pPath | Acts as a handle to the native object of type TPtxPdfContent_Path. |
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:
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Path *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Path_New | ( | void | ) |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathElement_GetAlignmentBox | ( | TPtxPdfContent_PathElement * | pPathElement, |
| TPtxGeomReal_Rectangle * | pAlignmentBox ) |
the box for alignment This is a rectangle that may not encompass all parts of an element, but is usefull for alignment.
| [in,out] | pPathElement | Acts as a handle to the native object of type TPtxPdfContent_PathElement. |
| [out] | pAlignmentBox | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Fill *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathElement_GetFill | ( | TPtxPdfContent_PathElement * | pPathElement | ) |
This path element's parameters for filling the path or NULL if the path is not filled.
| [in,out] | pPathElement | Acts as a handle to the native object of type TPtxPdfContent_PathElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Path *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathElement_GetPath | ( | TPtxPdfContent_PathElement * | pPathElement | ) |
This path element's path object.
| [in,out] | pPathElement | Acts as a handle to the native object of type TPtxPdfContent_PathElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Stroke *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathElement_GetStroke | ( | TPtxPdfContent_PathElement * | pPathElement | ) |
This path element's parameters for stroking the path or NULL if the path is not stroked.
| [in,out] | pPathElement | Acts as a handle to the native object of type TPtxPdfContent_PathElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_AddArc | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Rectangle * | pRectangle, | ||
| double | dAlpha1, | ||
| double | dAlpha2 ) |
Add an elliptical arc to the current path.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pRectangle | the surrounding rectangle of the ellipse |
| [in] | dAlpha1 | the angle between the x-axis and the begin of the arc |
| [in] | dAlpha2 | the angle between the x-axis and the end of the arc |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_AddCircle | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Point * | pCenter, | ||
| double | dRadius ) |
Append a circle to the current path as a complete subpath.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pCenter | the center of the circle |
| [in] | dRadius | the radius of the circle |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_AddEllipse | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Rectangle * | pRectangle ) |
Add an ellipse to the current path as a complete subpath.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pRectangle | the surrounding rectangle of the ellipse |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_AddPie | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Rectangle * | pRectangle, | ||
| double | dAlpha1, | ||
| double | dAlpha2 ) |
Add an elliptical piece of pie to the current path as a complete subpath.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pRectangle | the surrounding rectangle of the ellipse |
| [in] | dAlpha1 | the angle between the x-axis and the begin of the arc |
| [in] | dAlpha2 | the angle between the x-axis and the end of the arc |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_AddRectangle | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Rectangle * | pRectangle ) |
Append a rectangle to the current path as a complete subpath.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pRectangle | the rectangle to be added to the path |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_BezierTo | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Point * | pControlPoint1, | ||
| const TPtxGeomReal_Point * | pControlPoint2, | ||
| const TPtxGeomReal_Point * | pTarget ) |
Draw a bezier curve.
Append a cubic Bézier curve to the current path. The curve extends from the current point to the pTarget position, using pControlPoint1 and pControlPoint2 as the Bézier control points.
The current position is changed to the target position.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pControlPoint1 | the first bezier control point |
| [in] | pControlPoint2 | the second bezier control point |
| [in] | pTarget | the target coordinates |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_Close | ( | TPtxPdfContent_PathGenerator * | pObject | ) |
Close object.
Close disposable objects by invoking this function.
| [in] | pObject | Disposable object. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_CloseSubpath | ( | TPtxPdfContent_PathGenerator * | pPathGenerator | ) |
Close the current subpath. Close the current subpath by appending a straight line segment from the current point to the starting point of the subpath. This operator terminates the current subpath; appending another segment to the current path will begin a new subpath, even if the new segment begins at the endpoint reached by the closeSubpath() operation. If the current subpath has already been closed, CloseSubpath() does nothing.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_LineTo | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Point * | pTarget ) |
Draw a line. Append a straight line segment from the current point to the target coordinates. The current position is changed to the target position.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pTarget | the target coordinates |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_MoveTo | ( | TPtxPdfContent_PathGenerator * | pPathGenerator, |
| const TPtxGeomReal_Point * | pTarget ) |
Move the current position. Begin a new subpath by moving the current point to the specified coordinates, omitting any connecting line segment. If the previous path construction operator in the current path was also MoveTo, the new MoveTo overrides it; no vestige of the previous MoveTo operation remains in the path.
| [in,out] | pPathGenerator | Acts as a handle to the native object of type TPtxPdfContent_PathGenerator. |
| [in] | pTarget | the target coordinates |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_PathGenerator *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathGenerator_New | ( | TPtxPdfContent_Path * | pPath | ) |
Create a new path generator for appending to a path.
| [in,out] | pPath | the path object |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Subpath *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathIterator_GetValue | ( | TPtxPdfContent_PathIterator * | pPathIterator | ) |
Get the current element or NULLif no elements are left.
| [in,out] | pPathIterator | Acts as a handle to the native object of type TPtxPdfContent_PathIterator. |
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:
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_PathIterator_MoveNext | ( | TPtxPdfContent_PathIterator * | pPathIterator | ) |
Move the iterator to the next element.
| [in,out] | pPathIterator | Acts as a handle to the native object of type TPtxPdfContent_PathIterator. |
| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetDashArray | ( | TPtxPdfContent_Stroke * | pStroke, |
| double * | pBuffer, | ||
| size_t | nBufferSize ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [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 array pBuffer. |
pBuffer. -1 if there is an error. 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetDashPhase | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_LineCapStyle PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetLineCapStyle | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_LineJoinStyle PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetLineJoinStyle | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
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:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetLineWidth | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetMiterLimit | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_GetPaint | ( | TPtxPdfContent_Stroke * | pStroke | ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Stroke *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_New | ( | TPtxPdfContent_Paint * | pPaint, |
| double | dLineWidth ) |
| [in,out] | pPaint | |
| [in] | dLineWidth |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetDashArray | ( | TPtxPdfContent_Stroke * | pStroke, |
| const double * | pDashArray, | ||
| size_t | nDashArrays ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | pDashArray | Set value. |
| [in] | nDashArrays | Size of the array pDashArray. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetDashPhase | ( | TPtxPdfContent_Stroke * | pStroke, |
| double | dDashPhase ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | dDashPhase | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetLineCapStyle | ( | TPtxPdfContent_Stroke * | pStroke, |
| TPtxPdfContent_LineCapStyle | iLineCapStyle ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | iLineCapStyle | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetLineJoinStyle | ( | TPtxPdfContent_Stroke * | pStroke, |
| TPtxPdfContent_LineJoinStyle | iLineJoinStyle ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | iLineJoinStyle | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetLineWidth | ( | TPtxPdfContent_Stroke * | pStroke, |
| double | dLineWidth ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | dLineWidth | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetMiterLimit | ( | TPtxPdfContent_Stroke * | pStroke, |
| double | dMiterLimit ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in] | dMiterLimit | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Stroke_SetPaint | ( | TPtxPdfContent_Stroke * | pStroke, |
| TPtxPdfContent_Paint * | pPaint ) |
| [in,out] | pStroke | Acts as a handle to the native object of type TPtxPdfContent_Stroke. |
| [in,out] | pPaint | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Subpath_Get | ( | TPtxPdfContent_Subpath * | pSubpath, |
| int | iIndex, | ||
| TPtxPdfContent_PathSegment * | pPathSegment ) |
Returns the element at the specified position in the given list.
| [in,out] | pSubpath | Acts as a handle to the native object of type TPtxPdfContent_Subpath. |
| [in] | iIndex | |
| [out] | pPathSegment |
| PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Subpath_GetCount | ( | TPtxPdfContent_Subpath * | pSubpath | ) |
Get the number of elements in the list.
| [in,out] | pSubpath | Acts as a handle to the native object of type TPtxPdfContent_Subpath. |
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Subpath_GetStartPoint | ( | TPtxPdfContent_Subpath * | pSubpath, |
| TPtxGeomReal_Point * | pStartPoint ) |
The start point of the TPtxPdfContent_Subpath.
| [in,out] | pSubpath | Acts as a handle to the native object of type TPtxPdfContent_Subpath. |
| [out] | pStartPoint | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Subpath_IsClosed | ( | TPtxPdfContent_Subpath * | pSubpath | ) |
If TRUE, the TPtxPdfContent_Subpath represents a closed curve.
| [in,out] | pSubpath | Acts as a handle to the native object of type TPtxPdfContent_Subpath. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Text_Clear | ( | TPtxPdfContent_Text * | pText | ) |
Clear list.
| [in,out] | pText | Acts as a handle to the native object of type TPtxPdfContent_Text. |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Text *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Text_Create | ( | TPtxPdf_Document * | pTargetDocument | ) |
Create a text The returned text object is not yet used on any page, but it is associated with the given target document.
| [in,out] | pTargetDocument | the output document with which the returned object is associated |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_TextFragment *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Text_Get | ( | TPtxPdfContent_Text * | pText, |
| int | iIndex ) |
Returns the element at the specified position in the given list.
| [in,out] | pText | Acts as a handle to the native object of type TPtxPdfContent_Text. |
| [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:
| PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Text_GetCount | ( | TPtxPdfContent_Text * | pText | ) |
Get the number of elements in the list.
| [in,out] | pText | Acts as a handle to the native object of type TPtxPdfContent_Text. |
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Text_Remove | ( | TPtxPdfContent_Text * | pText, |
| int | iIndex ) |
Remove certain element from list.
| [in,out] | pText | Acts as a handle to the native object of type TPtxPdfContent_Text. |
| [in] | iIndex |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Text *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextElement_GetText | ( | TPtxPdfContent_TextElement * | pTextElement | ) |
This text element's text object.
| [in,out] | pTextElement | Acts as a handle to the native object of type TPtxPdfContent_TextElement. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Glyph *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_Get | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| int | iIndex ) |
Returns the element at the specified position in the given list.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [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:
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetBoundingBox | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| TPtxGeomReal_Rectangle * | pBoundingBox ) |
the bounding box This is a rectangle that encompasses all parts of the text fragment.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [out] | pBoundingBox | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetCharacterSpacing | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The additional spacing between glyphs When the glyph for each character in the text is rendered, the character spacing is added to the horizontal or vertical component of the glyph's displacement, depending on the writing mode. It is subject to scaling by the horizontal scaling if the writing mode is horizontal.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetCount | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
Get the number of elements in the list.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Fill *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetFill | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
This text fragment's parameters for filling the text or NULL if the text is not filled
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
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:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Font *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetFont | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The font The returned TPtxPdfContent_Font can only be used for extraction purposes. Specifically, using this object in PtxPdfContent_TextGenerator_New or in PtxPdfContent_TextGenerator_SetFont results in a ePtx_Error_IllegalArgument error.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
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:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetFontSize | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The font size.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetHorizontalScaling | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The horizontal scaling factor The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Its value is specified relative to the normal width of the glyphs, with 1 being the normal width.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetRise | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The rise of the baseline The text rise specifies the distance to move the baseline up or down from its default location. Positive values of text rise move the baseline up. Adjustments to the baseline are useful for drawing superscripts or subscripts.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Stroke *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetStroke | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
This text fragment's parameters for stroking the text or NULL if the text is not stroked
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
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:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetTextA | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The string painted by this text fragment
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetTextW | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The string painted by this text fragment
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetTransform | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| TPtxGeomReal_AffineTransform * | pTransform ) |
the transform to be applied to the bounding box rectangle Use this transform matrix to compute the actual location of the text fragment's bounding box.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [out] | pTransform | Retrieved value. |
| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetWordSpacing | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The additional spacing between words Word spacing works the same way as character spacing, but applies only to the space character, code 32.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
May indicate an error in certain scenarios. For further information see the note section below.
-1.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_WritingMode PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_GetWritingMode | ( | TPtxPdfContent_TextFragment * | pTextFragment | ) |
The writing direction This is the writing mode for the text fragment. It applies to all contained TPtxPdfContent_Glyphs.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextFragment_Remove | ( | TPtxPdfContent_TextFragment * | pTextFragment, |
| int | iIndex ) |
Remove certain element from list.
| [in,out] | pTextFragment | Acts as a handle to the native object of type TPtxPdfContent_TextFragment. |
| [in] | iIndex |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_Close | ( | TPtxPdfContent_TextGenerator * | pObject | ) |
Close object.
Close disposable objects by invoking this function.
| [in] | pObject | Disposable object. |
| PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_GetWidthA | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const char * | szText ) |
Get the width of a text string. The width of a text string as if it would be shown with the current settings.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text fragment |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULL | PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_GetWidthW | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const WCHAR * | szText ) |
Get the width of a text string. The width of a text string as if it would be shown with the current settings.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text fragment |
May indicate an error in certain scenarios. For further information see the note section below.
0.0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_MoveTo | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const TPtxGeomReal_Point * | pTarget ) |
Move the current position. This also also sets the beginning of the current line to the specified position, which will affect the PtxPdfContent_TextGenerator_ShowLine method.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | pTarget | the target position |
| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_TextGenerator *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_New | ( | TPtxPdfContent_Text * | pText, |
| TPtxPdfContent_Font * | pFont, | ||
| double | dFontSize, | ||
| const TPtxGeomReal_Point * | pLocation ) |
Create a new text generator for appending text to a text content object. All parameters that cannot be set in the constructor are set to default values:
NULL| [in,out] | pText | the text object |
| [in,out] | pFont | the initial font |
| [in] | dFontSize | the initial font size and leading |
| [in] | pLocation | the initial position. If position is NULL, the default position [0, 0] is used. |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetCharacterSpacing | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dCharacterSpacing ) |
the current character spacing.
When the glyph for each character in the string is rendered, the character spacing is added to the horizontal or vertical component of the glyph’s displacement, depending on the writing mode. It is subject to scaling by the horizontal scaling if the writing mode is horizontal.
Default value: 0
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dCharacterSpacing | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetFill | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| TPtxPdfContent_Paint * | pFill ) |
The paint for filling The fill paint or NULL if the text should not be filled.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in,out] | pFill | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetFont | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| TPtxPdfContent_Font * | pFont ) |
the current font. The font is used for all subsequent PtxPdfContent_TextGenerator_Show and PtxPdfContent_TextGenerator_ShowLine calls.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in,out] | pFont | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetFontSize | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dFontSize ) |
the current font size.
The font size is used for all subsequent PtxPdfContent_TextGenerator_Show and PtxPdfContent_TextGenerator_ShowLine calls.
Note that this sets the font size only. Also use PtxPdfContent_TextGenerator_SetLeading to set the leading.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dFontSize | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetHorizontalScaling | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dHorizontalScaling ) |
the current horizontal scaling.
The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Its value is specified relative to the normal width of the glyphs, with 1 being the normal width.
Default value: 1
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dHorizontalScaling | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetLeading | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dLeading ) |
the current leading.
The leading parameter specifies the vertical distance between the baselines of adjacent lines of text. It affects only the method PtxPdfContent_TextGenerator_ShowLine.
Default value: 1.2 times the initial font size.
See also PtxPdfContent_Font_GetLeading.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dLeading | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetRise | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dRise ) |
the current rise of the baseline.
Text rise specifies the distance to move the baseline up or down from its default location. Positive values of text rise move the baseline up. Adjustments to the baseline are useful for drawing superscripts or subscripts.
Default: 0
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dRise | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetStroke | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| TPtxPdfContent_Stroke * | pStroke ) |
The stroke properties The stroke properties or NULL if the text should not be stroked.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in,out] | pStroke | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_SetWordSpacing | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| double | dWordSpacing ) |
the current word spacing.
Word spacing works the same way as character spacing, but applies only to the space character, code 32.
Default value: 0
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | dWordSpacing | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_ShowA | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const char * | szText ) |
Show a text string. The text is shown using the current settings.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text to be shown |
NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_ShowLineA | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const char * | szText ) |
Show a text string and go to the next line.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text to be shown |
NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_ShowLineW | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const WCHAR * | szText ) |
Show a text string and go to the next line.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text to be shown |
NULL | PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_TextGenerator_ShowW | ( | TPtxPdfContent_TextGenerator * | pTextGenerator, |
| const WCHAR * | szText ) |
Show a text string. The text is shown using the current settings.
| [in,out] | pTextGenerator | Acts as a handle to the native object of type TPtxPdfContent_TextGenerator. |
| [in] | szText | the text to be shown |
NULL | PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Transparency_GetAlpha | ( | TPtxPdfContent_Transparency * | pTransparency | ) |
| [in,out] | pTransparency | Acts as a handle to the native object of type TPtxPdfContent_Transparency. |
May indicate an error in certain scenarios. For further information see the note section below.
-1 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:| PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_BlendMode PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Transparency_GetBlendMode | ( | TPtxPdfContent_Transparency * | pTransparency | ) |
| [in,out] | pTransparency | Acts as a handle to the native object of type TPtxPdfContent_Transparency. |
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. | PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Transparency *PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Transparency_New | ( | double | dAlpha | ) |
| [in] | dAlpha |
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:| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Transparency_SetAlpha | ( | TPtxPdfContent_Transparency * | pTransparency, |
| double | dAlpha ) |
| [in,out] | pTransparency | Acts as a handle to the native object of type TPtxPdfContent_Transparency. |
| [in] | dAlpha | Set value. |
| PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfContent_Transparency_SetBlendMode | ( | TPtxPdfContent_Transparency * | pTransparency, |
| TPtxPdfContent_BlendMode | iBlendMode ) |
| [in,out] | pTransparency | Acts as a handle to the native object of type TPtxPdfContent_Transparency. |
| [in] | iBlendMode | Set value. |
1.10.0