ITextDocument2::GetEffectColor-Methode (tom.h)

Ruft die Farbe ab, die für spezielle Textattribute verwendet wird.

Syntax

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

Parameter

[in] Index

Typ: long

Der Index der abzurufenden Farbe. Dieses Argument einen der folgenden Werte annehmen.

Index Bedeutung
0
Textfarbe.
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

Typ: long*

Die Farbe, die dem angegebenen Index entspricht.

Rückgabewert

Typ: HRESULT

Wenn die Methode erfolgreich ist, wird NOERROR zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Die ersten 16 Indexwerte gelten für spezielle Unterstreichungsfarben. Wenn ein Index zwischen 1 und 16 nicht durch einen Aufruf der ITextDocument2:SetEffectColor-Methode definiert wurde, gibt GetEffectColor die entsprechende Microsoft Word Standardfarbe zurück.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile tom.h
DLL Msftedit.dll

Weitere Informationen

ITextDocument2

ITextDocument2::SetEffectColor