ImageGear for C and C++ on Linux - Updated
IG_PDE_text_is_at_point
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_TEXT > IG_PDE_text_is_at_point

Tests whether a point is on specified text.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDE_text_is_at_point(
        HIG_PDE_TEXT hText,
        UINT nFlags,
        UINT nIndex,
        LPAT_PDF_FIXEDPOINT lpPoint,
        LPAT_BOOL lpbResult 
);

Arguments:

Name Type Description
hText HIG_PDE_TEXT Text object containing a character or text run.
nFlags UINT enumIGPDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. Must be either:
  • IG_PDE_TEXT_CHAR - for a text character
  • IG_PDE_TEXT_RUN - for a text run
nIndex UINT Index of the character or text run in the text object.
lpPoint LPAT_PDF_FIXEDPOINT The point, specified in user space coordinates.
lpbResult LPAT_BOOL TRUE if the point is on the text; FALSE otherwise.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Checks if the point is in a bounding box for hText.