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

Статья
08/15/2024

Содержит сведения о форматировании символов в элементе управления расширенными изменениями. 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