LAnnAutomation::SetBackColor

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetBackColor(crBack=RGB(0,0,0), uFlags=0)

COLORREF crBack;

/* the background color to set */

L_UINT uFlags;

/* reserved for future versions */

 

NOTE:

THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Sets the background color of the annotation object.

Parameter

Description

crBack

The COLORREF value that specifies the background color.

uFlags

Reserved for future versions, use 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Use the Windows COLORREF data type to specify the color. For example, you can use the LBitmapBase::GetPixelColor function or the Windows RGB macro to get a color value.

To see how the background color relates to the fill modes, refer to Illustration of Fill Options for Annotations.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

LAnnAutomation::SetForeColor, LAnnAutomation::GetBackColor, LAnnAutomation::GetForeColor, Class Members, LAnnAutomation::SetAutoHilightPen, LAnnAutomation::GetAutoHilightPen

Topics:

Annotation Functions: Object Properties

 

Using Color Values in LEADTOOLS

Example

For an example, refer to LAnnAutomation::GetBackColor.