C++ Syntax

bool

MKI_CalcTextFrame(

MKI_CONST_TEXTSTANDARD_REF f_rData,

const LPCWSTR f_pszText,

MKI_RECT_REF f_rFrame );

Calculates the surrounding frame of a standard text.

Parameters

Data

[MKI_CONST_TEXTSTANDARD_REF] Standard text parameter set used to display the given text.

Text

[const LPCWSTR] Text whose surrounding frame is to be calculated. This text may contain format information and encoded unicde characters.

Frame

[MKI_RECT_REF] Address of a rectangle buffer to receive the calculated surrounding frame. The coordinates are sorted, i.e. x1 <= x2 and y1 <= y2.

Return Value

Returns true if successful. If false is returned, the rectangle pointed to by Frame is not modified.

Comment

The resulting frame does surround the character cells, i.e. it is usually larger than the text's image. The values returned in Frame will always base on the text's insertion point indicated by Data->TextMatrix.m31 and Data->TextMatrix.m32, and will consider the text alignment.