структура CHARFORMAT2W (richedit.h)

Статья
03/08/2023

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

Синтаксис

struct CHARFORMAT2W : _charformatw {
  WORD     wWeight;
  SHORT    sSpacing;
  COLORREF crBackColor;
  LCID     lcid;
  union {
    DWORD dwReserved;
    DWORD dwCookie;
  };
  DWORD    dwReserved;
  SHORT    sStyle;
  WORD     wKerning;
  BYTE     bUnderlineType;
  BYTE     bAnimation;
  BYTE     bRevAuthor;
  BYTE     bUnderlineColor;
};

Наследование

Структура CHARFORMAT2W реализует _charformatw.

Элементы

wWeight

Тип: WORD

Вес шрифта. Этот элемент совпадает с элементом lfWeight структуры LOGFONT . Чтобы использовать этот элемент, установите флаг CFM_WEIGHT в элементе dwMask .

sSpacing

Тип: SHORT

Горизонтальное пространство между буквами в твипах. Это значение не оказывает влияния на текст, отображаемый элементом управления с расширенным редактированием; Он входит в состав для совместимости с интерфейсами Windows TOM. Чтобы использовать этот элемент, установите флаг CFM_SPACING в элементе dwMask .

crBackColor

Тип: COLORREF

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

lcid

Тип: LCID

32-разрядный идентификатор языкового стандарта, содержащий идентификатор языка в нижнем слове и идентификатор сортировки и зарезервированное значение в верхнем слове. Этот элемент не влияет на текст, отображаемый элементом управления с расширенным редактированием, но средства проверки орфографии и грамматики могут использовать его для решения проблем, зависящих от языка. Для создания значения LCID можно использовать макрос. Чтобы использовать этот элемент, установите флаг CFM_LCID в элементе dwMask .

dwReserved

Тип: DWORD

Защищены; значение должно быть равно нулю.

Тип: DWORD

Защищены; значение должно быть равно нулю.

dwCookie

Тип: DWORD

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

sStyle

Тип: SHORT

Дескриптор стиля символов. Это значение не оказывает влияния на текст, отображаемый элементом управления с расширенным редактированием; он включен для совместимости с интерфейсами WindowsTOM. Чтобы использовать этот элемент, установите флаг CFM_STYLE в элементе dwMask . Дополнительные сведения см. в документации по TOM.

wKerning

Тип: WORD

Значение размера шрифта, выше которого необходимо кернировать символ (yHeight). Это значение не оказывает влияния на текст, отображаемый элементом управления с расширенным редактированием; он включен для совместимости с интерфейсами TOM. Чтобы использовать этот элемент, установите флаг CFM_KERNING в элементе dwMask .

bUnderlineType

Тип: BYTE

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

Значение	Значение
CFU_CF1UNDERLINE	Структура сопоставляет битовое подчеркивание CHARFORMATс CHARFORMAT2 (то есть выполняет подчеркивание типа CHARFORMAT в этом тексте).
CFU_INVERT	Для композиции IME подделывая выборка.
CFU_UNDERLINE	Текст, подчеркнутый одной сплошной линией.
CFU_UNDERLINEDASH	Текст, подчеркнутый тире.
CFU_UNDERLINEDASHDOT	Текст, подчеркнутый пунктирной линией.
CFU_UNDERLINEDASHDOTDOT	Текст, подчеркнутый пунктирной и удвоенной пунктирной линией.
CFU_UNDERLINEDOTTED	Текст, подчеркнутый пунктирной линией. Для версий, предшествующих Microsoft Rich Edit 3.0, текст отображается с сплошным подчеркиванием.
CFU_UNDERLINEDOUBLE	Текст, подчеркнутый двойной строкой. Элемент управления форматированным редактированием отображает текст с сплошным подчеркиванием.
CFU_UNDERLINEDOUBLEWAVE	Отображается как CFU_UNDERLINEWAVE.
CFU_UNDERLINEHAIRLINE	Отображается как CFU_UNDERLINE.
CFU_UNDERLINEHEAVYWAVE	Отображается как CFU_UNDERLINEWAVE.
CFU_UNDERLINELONGDASH	Отображается как CFU_UNDERLINEDASH.
CFU_UNDERLINENONE	Без подчеркивания. Это значение по умолчанию.
CFU_UNDERLINETHICK	Отображается как CFU_UNDERLINE.
CFU_UNDERLINETHICKDASH	Отображается как CFU_UNDERLINEDASH.
CFU_UNDERLINETHICKDASHDOT	Отображается как CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDASHDOTDOT	Отображается как CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDOTTED	Отображается как CFU_UNDERLINEDOT.
CFU_UNDERLINETHICKLONGDASH	Отображается как CFU_UNDERLINEDASH.
CFU_UNDERLINEWAVE	RichEdit 4.1 и более поздних версий: текст, подчеркнутый волнистой линией.
CFU_UNDERLINEWORD	RichEdit 4.1 и более поздних версий: подчеркивание только слов. Элемент управления форматированным редактированием отображает текст с сплошным подчеркиванием.

bAnimation

Тип: BYTE

Тип анимации текста. Это значение не оказывает влияния на текст, отображаемый элементом управления с расширенным редактированием; он включен для совместимости с интерфейсами TOM. Чтобы использовать этот элемент, установите флаг CFM_ANIMATION в элементе dwMask .

bRevAuthor

Тип: BYTE

Индекс, определяющий автора, который вносит редакцию. Элемент управления "Форматированный редактирование" использует разные цвета текста для каждого индекса автора. Чтобы использовать этот элемент, установите флаг CFM_REVAUTHOR в элементе dwMask .

bUnderlineColor

Тип: BYTE

Цвет подчеркивания:

UnderlineColor_Black = 0x00;
UnderlineColor_Blue = 0x01;
UnderlineColor_Aqua = 0x02;
UnderlineColor_Lime = 0x03;
UnderlineColor_Fuchsia = 0x04;
UnderlineColor_Red = 0x05;
UnderlineColor_Yellow = 0x06;
UnderlineColor_White = 0x07;
UnderlineColor_Navy = 0x08;
UnderlineColor_Teal = 0x09;
UnderlineColor_Green = 0x0A;
UnderlineColor_Purple = 0x0B;
UnderlineColor_Maroon = 0x0C;
UnderlineColor_Olive = 0x0D;
UnderlineColor_DkGray = 0x0E;
UnderlineColor_LtGray = 0x0F;

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

Примечание

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

Требования

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