LAnnotation::SetAutoBackColor
#include "ltwrappr.h"
virtual L_INT LAnnotation::SetAutoBackColor(uObjectType, crBack)
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 |
uObjectType |
Type of object for which to change the background color. 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. 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. |
See Also
Example
For an example, refer to LAnnotation::GetAutoBackColor.