ITextHost::TxGetSysColor method (textserv.h)

Article
02/22/2024

Retrieves the text host's color for a specified display element.

Syntax

COLORREF TxGetSysColor(
  [in] int nIndex
);

Parameters

[in] nIndex

Type: INT

The display element whose color is to be retrieved. For a list of possible values for this parameter, see the GetSysColor function.

Return value

Type: COLORREF

The value that identifies the red, green, and blue (RGB) color value of the specified element.

Remarks

Note that the color returned may be different than the color that would be returned from a call to GetSysColor. This is the case if the host overrides the default system behavior.

Note Hosts should be careful about overriding normal system behavior because it can result in inconsistent UI (particularly with respect to Accessibility options).

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	textserv.h
DLL	Msftedit.dll