SetTextAlign

  UINT SetTextAlign(hdc, fMode)    
  HDC hdc;    
  UINT fMode;    

The SetTextAlign function sets the text-alignment flags for the given device context. The TextOut and ExtTextOut functions use these flags when positioning a string of text on a display or 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.

Parameters

hdc

Identifies the device context.

fMode

Specifies a mask of the values in the following list. Only one flag may 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:

Value Meaning

TA_BASELINE  
  The reference point will be on the baseline of the text.
TA_BOTTOM  
  The reference point will be on the bottom edge of the bounding rectangle.
TA_TOP  
  The reference point will be on the top edge of the bounding rectangle.
TA_CENTER  
  The reference point will be aligned horizontally with the center of the bounding rectangle.
TA_LEFT  
  The reference point will be on the left edge of the bounding rectangle.
TA_RIGHT  
  The reference point will be on the right edge of the bounding rectangle.
TA_NOUPDATECP  
  The current position is not updated after each text output call. The reference point is passed to the text output function.
TA_UPDATECP  
  The current position is updated after each text output call. The current position is used as the reference point.

When the current font has a vertical default baseline, e.g. as with Kanji, then the following values must be used instead of TA_BASELINE and TA_CENTER.

Value Meaning

VTA_BASELINE  
  The reference point will be on the baseline of the text.
VTA_CENTER  
  The reference point will be aligned vertically with the center of the bounding rectangle.

The defaults are TA_LEFT, TA_TOP, and TA_NOUPDATECP.

Return Value

The return value specifies the previous text alignment setting. If an error occurs, the value ERROR is returned.

See Also

ExtTextOut, TextOut