Структура CHARFORMATA (richedit.h)

  • Статья

Содержит сведения о форматировании символов в элементе управления полнофункционированным редактированием.

Rich Edit 2.0: Структура CHARFORMAT2 является расширением Microsoft Rich Edit 2.0 структуры CHARFORMAT . Microsoft Rich Edit 2.0 и более поздних версий позволяет использовать обе структуры с EM_GETCHARFORMAT и EM_SETCHARFORMAT сообщений.

Синтаксис

typedef struct _charformat {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  char     szFaceName[LF_FACESIZE];
} CHARFORMATA;

Члены

cbSize

Тип: UINT

Размер указанной структуры в байтах. Этот элемент необходимо задать перед передачей структуры в элемент управления полнофункционированным редактированием.

dwMask

Тип: DWORD

Элементы, содержащие допустимые сведения или атрибуты для задания. Этот элемент может быть равен нулю, одному или нескольким из следующих значений.

Значение Значение
CFM_ALL
 Windows 8: сочетание следующих значений: CFM_EFFECTS | CFM_SIZE | CFM_FACE | CFM_OFFSET | CFM_CHARSET
CFM_BOLD
 Допустимое CFE_BOLD значение элемента dwEffects .
CFM_CHARSET
 Допустимый член bCharSet .
CFM_COLOR
 Член crTextColor и CFE_AUTOCOLOR значение элемента dwEffects являются допустимыми .
CFM_EFFECTS
 Windows 8: сочетание следующих значений: CFM_BOLD | CFM_ITALIC | CFM_UNDERLINE | CFM_COLOR | CFM_STRIKEOUT | CFE_PROTECTED | CFM_LINK
CFM_FACE
 Допустимый член szFaceName .
CFM_ITALIC
 Допустимое CFE_ITALIC значение элемента dwEffects .
CFM_OFFSET
 Допустимый член yOffset .
CFM_PROTECTED
 Допустимое CFE_PROTECTED значение элемента dwEffects .
CFM_SIZE
 Допустимый член yHeight .
CFM_STRIKEOUT
 Допустимое значение CFE_STRIKEOUT члена dwEffects .
CFM_UNDERLINE.
 Допустимое значение CFE_UNDERLINE члена dwEffects .

dwEffects

Тип: DWORD

Эффекты символов. Этот элемент может быть сочетанием следующих значений.

Значение Значение
CFE_AUTOCOLOR
 Цвет текста — это возвращаемое значение GetSysColor(COLOR_WINDOWTEXT).
CFE_BOLD
 Символы выделены полужирным шрифтом.
CFE_DISABLED
 RichEdit 2.0 и более поздних версий: Символы отображаются с тенью, которая смещена на 3/4 точки или на один пиксель, в зависимости от того, какой из них больше.
CFE_ITALIC
 Символы курсивом.
CFE_STRIKEOUT
 Персонажи поражены.
CFE_UNDERLINE
 Символы подчеркнуты.
CFE_PROTECTED
 Символы защищены; Попытка изменить их приведет к EN_PROTECTED коду уведомления.

yHeight

Тип: LONG

Высота символа в твипах (1/1440 дюйма или 1/20 точки принтера).

yOffset

Тип: LONG

Смещение символов (в твипах) от базового плана. Если значение этого элемента является положительным, символ является надстрочной; Если значение отрицательное, символ является подстроком.

crTextColor

Тип: COLORREF

Цвет текста. Этот элемент игнорируется, если указан CFE_AUTOCOLOR символьный эффект. Чтобы создать COLORREF, используйте макрос RGB .

bCharSet

Тип: BYTE

Значение набора символов. Элемент bCharSet может быть одним из значений, указанных для элемента lfCharSet структуры LOGFONT . Microsoft Rich Edit 3.0 может переопределить это значение, если оно является недопустимым для целевых символов.

bPitchAndFamily

Тип: BYTE

Семейство шрифтов и шаг. Этот элемент совпадает с элементом lfPitchAndFamily структуры LOGFONT .

szFaceName[LF_FACESIZE]

Тип: TCHAR[LF_FACESIZE]

Массив символов, заканчивающийся значением NULL, указывающий имя шрифта.

Комментарии

Чтобы отключить атрибут форматирования, задайте соответствующее значение в dwMask , но не задайте соответствующее значение в dwEffects. Например, чтобы отключить курсив, задайте CFM_ITALIC, но не CFE_ITALIC.

Примечание

Заголовок richedit.h определяет CHARFORMAT как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Верхняя часть richedit.h

См. также раздел

CHARFORMAT2

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

Справочные материалы