Help Center

CTextDocument2.SetEffectColormethod

Specifies the color to use for special text attributes.

Windowsmethoddoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION SetEffectColor (BYVAL Index AS LONG, BYVAL Value AS ULONG) AS HRESULT

Parameters

NameDescription
IndexThe index of the color to retrieve. For a list of values, see the table below.
ValueThe new color for the specified index.

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Description

Specifies the color to use for special text attributes.

Remarks

The first 16 index values are for special underline colors. If an index between 1 and 16 hasn't been defined by a call to the SetEffectColor method of the ITextDocument2 interface, the corresponding Microsoft Word default color is used.

Reference