L_AnnSetAutoBackColor
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnSetAutoBackColor(hObject, uObjectType, crBack)
HANNOBJECT hObject; |
/* handle to the automation object */ |
L_UINT uObjectType; |
/* object type */ |
COLORREF crBack; |
/* COLORREF value that specifies the background color */ |
Sets the background color of one or more annotation objects. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
hObject |
Handle to the annotation object. |
uObjectType |
Type of the object, which is having its background color changed. For a list of possible values, refer to Types of Annotations. |
crBack |
The COLORREF value that specifies the background color. |
Returns
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. |
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
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
Example
For an example, refer to L_AnnGetAutoBackColor.