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

This function links text of annotation marks given by lpMarkIndexes parameter and distributes it between these marks according to their bounds so that all of the marks do not have overflowed text excluding may be the last one if the linked text needs more space to be drawn than the marks allow.

Declaration:

 
Copy Code
AT_ERRCOUNT ART_GUI_text_flow ( 
        HIGEAR hIGear, 
        DWORD dwGrpID, 
        HWND hWnd, 
        const LPART_MARK_INDEX lpMarkIndexes, 
        DWORD dwMarkCount 
);

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.
lpMarkIndexes const LPART_MARK_INDEX Array of text mark identifiers.
dwMarkCount DWORD Number of mark in lpMarkIndexes array.

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:

If the text needs less space then the total mark bounds some of the marks may be empty. The function does not change the mark bounds and does not repaint them.

The function can be applied only for Typed Text(ART_MARK_TYPED_TEXT) and Attach-a-Note(ART_MARK_ATTACH_A_NOTE) marks. If the lpMarkIndexes array contains indexes of marks different from ART_MARK_TYPED_TEXT or ART_MARK_ATTACH_A_NOTE an error will occur, and the function will do nothing.