Функция GetTextAlign (wingdi.h)

Статья
03/09/2024

Функция GetTextAlign извлекает параметр выравнивания текста для указанного контекста устройства.

Синтаксис

UINT GetTextAlign(
  [in] HDC hdc
);

Параметры

[in] hdc

Дескриптор контекста устройства.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение — это состояние флагов выравнивания текста. Дополнительные сведения о возвращаемом значении см. в разделе Примечания. Возвращаемое значение представляет собой сочетание следующих значений.

Значение	Значение
TA_BASELINE	Точка отсчета находится в базовой строке текста.
TA_BOTTOM	Точка отсчета находится на нижнем краю ограничивающего прямоугольника.
TA_TOP	Точка отсчета находится на верхнем крае ограничивающего прямоугольника.
TA_CENTER	Точка отсчета выравнивается по горизонтали по центру ограничивающего прямоугольника.
TA_LEFT	Точка отсчета находится на левом краю ограничивающего прямоугольника.
TA_RIGHT	Точка отсчета находится на правом краю ограничивающего прямоугольника.
TA_RTLREADING	Выпуск Windows для ближневосточных языков: Текст расположен в порядке чтения справа налево, в отличие от порядка чтения слева направо по умолчанию. Это применимо, только если в контексте устройства выбран шрифт иврит или арабский.
TA_NOUPDATECP	Текущая позиция не обновляется после каждого вызова вывода текста.
TA_UPDATECP	Текущая позиция обновляется после каждого вызова вывода текста.

Если текущий шрифт имеет вертикальную базовую линию по умолчанию (как в случае с кандзи), вместо TA_BASELINE и TA_CENTER используются следующие значения.

Значение	Значение
VTA_BASELINE	Точка отсчета находится в базовой строке текста.
VTA_CENTER	Точка отсчета выравнивается по вертикали по центру ограничивающего прямоугольника.

Если функция завершается сбоем, возвращаемое значение будет GDI_ERROR.

Ограничивающий прямоугольник — это прямоугольник, ограничивающий все символьные ячейки в строке текста. Его измерения можно получить, вызвав функцию GetTextExtentPoint32 .

Флаги выравнивания текста определяют, как функции TextOut и ExtTextOut выравнивают строку текста по отношению к опорной точке строки, предоставленной для TextOut или ExtTextOut.

Флаги выравнивания текста не обязательно являются одноразрядными флагами и могут быть равны нулю. Флаги должны проверяться в группах связанных флагов, как показано в следующем списке.

TA_LEFT, TA_RIGHT и TA_CENTER
TA_BOTTOM, TA_TOP и TA_BASELINE
TA_NOUPDATECP и TA_UPDATECP

Если текущий шрифт имеет вертикальную базовую линию по умолчанию, связанные флаги отображаются, как показано в следующем списке.

TA_LEFT, TA_RIGHT и VTA_BASELINE
TA_BOTTOM, TA_TOP и VTA_CENTER
TA_NOUPDATECP и TA_UPDATECP

Чтобы убедиться, что определенный флаг задан в возвращаемом значении этой функции, выполните следующие действия:

Примените побитовый оператор OR к флагу и связанным с ним флагам.
Примените побитовый оператор AND к результату и возвращаемого значения.
Проверка на равенство этого результата и флага.

Примеры

Пример см. в разделе Настройка выравнивания текста.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	wingdi.h (включая Windows.h)
Библиотека	Gdi32.lib
DLL	Gdi32.dll