Метод ITextDocument2::GetEffectColor (tom.h)

Извлекает цвет, используемый для специальных атрибутов текста.

Синтаксис

HRESULT GetEffectColor(
  [in]  long Index,
  [out] long *pValue
);

Параметры

[in] Index

Тип: long

Индекс извлекаемого цвета. Может быть одним из указанных далее.

Индекс Значение
0
Цвет текста.
1
RGB(0, 0, 0)
2
RGB(0, 0, 255)
3
RGB(0, 255, 255)
4
RGB(0, 255, 0)
5
RGB(255, 0, 255)
6
RGB(255, 0, 0)
7
RGB(255, 255, 0)
8
RGB(255, 255, 255)
9
RGB(0, 0, 128)
10
RGB(0, 128, 128)
11
RGB(0, 128, 0)
12
RGB(128, 0, 128)
13
RGB(128, 0, 0)
14
RGB(128, 128, 0)
15
RGB(128, 128, 128)
16
RGB(192, 192, 192)

[out] pValue

Тип: long*

Цвет, соответствующий указанному индексу.

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

Тип: HRESULT

Если метод завершается успешно, он возвращает noERROR. В противном случае возвращается код ошибки HRESULT .

Комментарии

Первые 16 значений индекса предназначены для специальных цветов подчеркивания. Если индекс в диапазоне от 1 до 16 не определен вызовом метода ITextDocument2:SetEffectColor, GetEffectColor возвращает соответствующий цвет Microsoft Word по умолчанию.

Требования

Требование Значение
Минимальная версия клиента Windows 8 [только классические приложения]
Минимальная версия сервера Windows Server 2012 [только классические приложения]
Целевая платформа Windows
Header tom.h
DLL Msftedit.dll

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

ITextDocument2

ITextDocument2::SetEffectColor