TextDocument.GetEffectColor Method

TextDocumentGetEffectColor Method

(TOM 2 only) Retrieves the color used for special text attributes.

Namespace: TextObjectModel
Assembly: ManagedTOM2 (in ManagedTOM2.dll) Version: 1.0.5577.41188

Syntax

public Color GetEffectColor(
	int index
)

Public Function GetEffectColor ( 
	index As Integer
) As Color

public:
Color GetEffectColor(
	int index
)

Type: Color
The color that corresponds to the specified index.

Exceptions

Exception	Condition
NotSupportedException	The underlying COM object does not implement the ITextDocument2 interface.

Remarks

Indexes in the range [1-16] are for special underline colors, and can be redefined with the SetEffectColor(Int32, Color) method.