In This Topic ▼

L_AnnSetAutoBackColor

Summary

Sets the background color of one or more annotation objects.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetAutoBackColor(hObject, uObjectType, crBack)

Parameters

L_UINT uObjectType

Type of the object, which is having its background color changed. For a list of possible values, refer to Types of Annotations.

COLORREF crBack

The COLORREF value that specifies the background color.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function does not affect objects that do not have this property or that do not let you change the property. The automation back color is used as a default for all annotation objects that are created (using automation) from that point on. For descriptions of the various types of objects and their properties, refer to Types of Annotations. Please note the following:

If uObjectType is	Then the background color is changed for
ANNOBJECT_NOTE or ANNOBJECT_PUSHPIN	Note objects and push pin objects created by the automation object.
ANNOBJECT_HILITE	Hilite objects created by the automation object.
ANNOBJECT_REDACT	Redact objects created by the automation object.
any other object such as ANNOBJECT_TEXT, ANNOBJECT_RECT, etc.	All other objects, created by the automation object, which have a background color property.