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

Статья
08/15/2024

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

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

См. также

Справочник

Поделиться через