ITextFont::SetForeColor method

Sets the foreground (text) color.

Syntax


HRESULT SetForeColor(
  [inlong Value
);

Parameters

Value [in]

Type: long

The new foreground color. It can be one of the following.

ValueMeaning
A COLORREF value.An RGB color.
A value returned by PALETTEINDEX A palette index.
tomUndefinedNo change.
tomAutoColorUse the default foreground color.

 

If Value contains an RGB color, generate the COLORREF by using the RGB macro.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return codeDescription
E_INVALIDARG

Invalid argument.

CO_E_RELEASED

The font object is attached to a range that has been deleted.

E_ACCESSDENIED

Write access is denied.

E_OUTOFMEMORY

Insufficient memory.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextFont
GetForeColor
Conceptual
Text Object Model
Other Resources
COLORREF
PALETTEINDEX
RGB

 

 

Show: