SetTextAlign function (wingdi.h)
The SetTextAlign function sets the text-alignment flags for the specified device context.
Syntax
UINT SetTextAlign(
[in] HDC hdc,
[in] UINT align
);
Parameters
[in] hdc
A handle to the device context.
[in] align
The text alignment by using a mask of the values in the following list. Only one flag can be chosen from those that affect horizontal and vertical alignment. In addition, only one of the two flags that alter the current position can be chosen.
When the current font has a vertical default base line, as with Kanji, the following values must be used instead of TA_BASELINE and TA_CENTER.
Value | Meaning |
---|---|
|
The reference point will be on the base line of the text. |
|
The reference point will be aligned vertically with the center of the bounding rectangle. |
The default values are TA_LEFT, TA_TOP, and TA_NOUPDATECP.
Return value
If the function succeeds, the return value is the previous text-alignment setting.
If the function fails, the return value is GDI_ERROR.
Remarks
The TextOut and ExtTextOut functions use the text-alignment flags to position a string of text on a display or other device. The flags specify the relationship between a reference point and a rectangle that bounds the text. The reference point is either the current position or a point passed to a text output function.
The rectangle that bounds the text is formed by the character cells in the text string.
The best way to get left-aligned text is to use either
SetTextAlign (hdc, GetTextAlign(hdc) & (~TA_CENTER))
or
SetTextAlign (hdc,TA_LEFT | <other flags>)
You can also use SetTextAlign (hdc, TA_LEFT) for this purpose, but this loses any vertical or right-to-left settings.
Examples
For an example, see Setting the Text Alignment.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | wingdi.h (include Windows.h) |
Library | Gdi32.lib |
DLL | Gdi32.dll |