StringFormat::SetAlignment method (gdiplusstringformat.h)

The StringFormat::SetAlignment method sets the character alignment of this StringFormat object in relation to the origin of the layout rectangle. A layout rectangle is used to position the displayed string.

Syntax

Status SetAlignment(
  [in] StringAlignment align
);

Parameters

[in] align

Type: StringAlignment

Element of the StringAlignment enumeration that specifies how a string is aligned in reference to the bounding rectangle.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

Requirement	Value
Minimum supported client	Windows XP, Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	gdiplusstringformat.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll

See also

Font

RectF

Status

StringAlignment

StringFormat