LAnnHilite::SetBackColor

#include "ltwrappr.h"

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

COLORREF crBack;

/* the background color */

L_UINT uFlags;

/* flags that indicate the object to process */

 

NOTE:

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

Sets the background color of the annotation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

crBack

The COLORREF value that specifies the background color.

uFlags

Flags that determine the object to process. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You 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.

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.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Using Color Values in LEADTOOLS

Example

For an example, refer to LAnnHilite::GetBackColor.