CRichEditCtx.GetEffectColormethod

Windowsmethoddocumented

Syntax

FUNCTION GetEffectColor (BYVAL Index AS LONG) AS ULONG

Also documented as EffectColor — one description covers them all.

Parameters

Name		Description
`Index`		The index of the color to retrieve. It can be one of the following values:
`Value`		The new color for the specified index.

Return value

(GET) The color that corresponds to the specified index.

Description

Retrieves the color used 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, GetEffectColor returns the corresponding Microsoft Word default color.

Example

(GET) PROPERTY EffectColor (BYVAL Index AS LONG) AS ULONG (SET) PROPERTY EffectColor (BYVAL Index AS LONG, BYVAL Value AS ULONG)

Reference

Defined in AfxNova/CRichEditCtx.inc:4711
Documented in Windows/WIndows Controls/RichEdit/CRichEditCtx Class.md
Topic: CRichEditCtx Class