ImageGear for C and C++ on Windows v19.9 - Updated
ART_GUI_text_overflow_check
API Reference Guide > ART Component API Reference > ART Component Functions Reference > GUI Functions > ART_GUI_text_overflow_check

This function checks the mark with text overflowed.

Declaration:

 
Copy Code
AT_ERRCOUNT ART_GUI_text_overflow_check( 
        HIGEAR hIGear, 
        DWORD dwGrpID,
        HWND hWnd, 
        ART_MARK_INDEX hMarkIndex,
        LPAT_RECT lprcPreferableBounds,
        LPDWORD lpdwOverflowedTextLength
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle to the image.
dwGrpID DWORD Identifier of group.
hWnd HWND Windows handle to the image window to draw marks.
hMarkIndex ART_MARK_INDEX Identifier of the mark.
lprcPreferableBounds LPAT_RECT Returns preferable mark bounds to draw whole mark text (cut to clip bounds).
lpdwOverflowed TextLength LPDWORD Returns the length of overflowed text (the last NULL is not included) or 0.

Return Value:

Returns the number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

Annotation

Example:

See example for LPFNIG_ART_TEXTOVERFLOWNOTIFYFUNC callback function.

Remarks:

It can be applied for ART_MARK_TYPED_TEXT, ART_MARK_ATTACH_A_NOTE and ART_MARK_TEXT_FROM_FILE marks only. If the mark has overflowed text the lpdwOverflowedTextLength returns the number of overflowed text characters. Otherwise it returns 0.

The lprcPreferableBounds returns rectangle of mark bounds enough to draw the whole text. It is made by expanding the mark bounds in direction the drawn text (from top to bottom direction) is cut to the image window clip bounds.