| int DrawText(hdc, lpsz, cb, lprc, fuFormat) | |||||
| HDC hdc; | /* handle of device context | */ | |||
| LPCSTR lpsz; | /* address of string to draw | */ | |||
| int cb; | /* string length | */ | |||
| RECT FAR* lprc; | /* address of structure with formatting dimensions | */ | |||
| UINT fuFormat; | /* text-drawing flags, */ | ||||
The DrawText function draws formatted text into a given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the rectangle, and breaking text into lines that fit within the rectangle.
The DrawText function uses the device context's selected font, text color, and background color to draw the text. Unless the DT_NOCLIP format is specified, DrawText clips the text so that the text does not appear outside the given rectangle. All formatting is assumed to have multiple lines unless the DT_SINGLELINE format is specified.
hdc
Identifies the device context. This cannot be a metafile device context.
lpsz
Points to the string to be drawn. If the cb parameter is –1, the string must be null-terminated.
cb
Specifies the number of bytes in the string. If this parameter is –1, then the lpsz parameter is assumed to be a long pointer to a null-terminated string and DrawText computes the character count automatically.
lprc
Points to a RECT structure that contains the logical coordinates of the upper-left and lower-right corners of the rectangle in which the text is to be formatted. The RECT structure has the following form:
typedef struct tagRECT { /* rc */
int left;
int top;
int right;
int bottom;
} RECT;For a full description of this structure, see the Microsoft Windows Programmer's Reference, Volume 3.
fuFormat
Specifies an array of flags that determine how to draw the text. This parameter can be a combination of the following values:
| Value | Meaning |
| DT_BOTTOM | Specifies bottom-aligned text. This value must be combined with DT_SINGLELINE. |
| DT_CALCRECT | Determines the width and height of the rectangle. If there are multiple lines of text, DrawText will use the width of the rectangle pointed to by the lprc parameter and extend the base of the rectangle to bound the last line of text. If there is only one line of text, DrawText will modify the right side of the rectangle so that it bounds the last character in the line. In either case, DrawText returns the height of the formatted text but does not draw the text. |
| DT_CENTER | Centers text horizontally. |
| DT_EXPANDTABS | Expands tab characters. The default number of characters per tab is eight. |
| DT_EXTERNALLEADING | Includes the font external leading in line height. Normally, external leading is not included in the height of a line of text. |
| DT_LEFT | Left-aligns text. |
| DT_NOCLIP | Draws without clipping. DrawText is somewhat faster when DT_NOCLIP is used. |
| DT_NOPREFIX | Turns off processing of prefix characters. Normally, DrawText interprets the mnemonic & as a directive to underscore the character that follows, and the mnemonic && as a directive to print a single &. By specifying DT_NOPREFIX, this processing is turned off. |
| DT_RIGHT | Right-aligns text. |
| DT_SINGLELINE | Specifies single line only. Carriage returns and linefeeds do not break the line. |
| DT_TABSTOP | Sets tab stops. The high-order byte of the fuFormat parameter is the number of characters for each tab. The default number of characters per tab is eight. |
| DT_TOP | Specifies top-aligned text (single line only). |
| DT_VCENTER | Specifies vertically centered text (single line only). |
| DT_WORDBREAK | Specifies word breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lprc parameter. A carriage return–linefeed sequence will also break the line. |
Note that the DT_CALCRECT, DT_EXTERNALLEADING, DT_INTERNAL, DT_NOCLIP, and DT_NOPREFIX values cannot be used with the DT_TABSTOP value.
The return value specifies the height of the text if the function is successful.
If the selected font is too large for the specified rectangle, the DrawText function does not attempt to substitute a smaller font.
If the DT_CALCRECT flag is specified, the RECT structure pointed to by the lprc parameter will be updated to reflect the width and height needed to draw the text.
If the TA_UPDATECP text-alignment flag has been set (see the SetTextAlign function), DrawText will display text starting at the current position, rather than at the left of the given rectangle. DrawText will not wrap text when the TA_UPDATECP flag has been set (the DT_WORDBREAK flag will have no effect).
The text color must be set by the SetTextColor function.