ITextDocument2::SetEffectColor method (tom.h)

Article
02/22/2024

Specifies the color to use for special text attributes.

Syntax

HRESULT SetEffectColor(
  [in] long Index,
  [in] long Value
);

Parameters

[in] Index

Type: long

The index of the color to retrieve. For a list of values, see GetEffectColor.

[in] Value

Type: long

The new color for the specified index.

Return value

Type: HRESULT

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

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 ITextDocument2:SetEffectColor method, the corresponding Microsoft Word default color is used.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll