Show/Hide Toolbars

EmEditor Help

Navigation: » No topics above this level «

EmEditor Plug-in Reference: Editor_GetColor

Scroll Prev Top Next More
EmEditor Home - EmEditor Help - Plug-in Reference - Inline Functions

Editor_GetColor

Retrieves the text and background colors and style for the specified part. You can use this inline function or explicitly send the EE_GET_COLOR message.

Editor_GetColor( HWND hwnd, BOOL bFind, UINT nIndex, COLORREF* pclrText, COLORREF* pclrBack, int* pnAttr );

Parameters

hwnd

Specifies the window handle of the view or frame of EmEditor.

bFind

Specifies TRUE if retrieving colors for Find, or FALSE if retrieving colors for one of other parts.

nIndex

Specifies the index to retrieve colors. If bFind is FALSE, the index must be less than MAX_SMART_COLOR.

pclrText

Specifies a pointer to retrieve the text color. It is an RGB value of the color or one of the following values.

DEFAULT_COLOR

The Windows system color is used.

TRANSPARENT_COLOR

The color is transparent.

pclrBack

Specifies a pointer to retrieve the background color. It is an RGB value of the color or one of the following values.

DEFAULT_COLOR

The Windows system color is used.

TRANSPARENT_COLOR

The color is transparent.

pnAttr

Specifies a pointer to retrieve the style. It is one of the following values.

SMART_COLOR_FONT_NORMAL

The font is normal.

SMART_COLOR_FONT_UNDERLINE

The font is underlined.

SMART_COLOR_FONT_BOLD

The font is bold.

SMART_COLOR_FONT_ITALIC

The font is italic.

SMART_COLOR_FONT_WIGGLY

The font is wiggly.

SMART_COLOR_FONT_DOTTED

In case of lines, the specified lines are dotted.

Return Values

The return value is TRUE if succeeded, or FALSE if failed.

Version

Supported on Version 14.4 or later.

Copyright © 2003-2016 by Emurasoft, Inc.