AnnSetAutoBackColor method (Annotation Control)
|
Builder Syntax |
int AnnSetAutoBackColor(HANNOBJECT hObject, int nType, TColor &clBack) |
|
Delphi Syntax |
Function AnnSetAutoBackColor (hObject: HANNOBJECT; nType: L_INT; var clBack: TColor): L_INT |
|
Overview |
Refer to Implementing Annotations. |
Remarks
(Document/Medical only) Sets the background color of one or more annotation objects. The automation back color is used as a default for all annotation objects that are created (using automation) from that point on.
This method 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 nType 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. |
VCL uses the TColor enumerated data type that covers the values that can be returned by the Windows RGB macro. To convert from a TColor value to a COLORREF value, call the ColorToRGB method. To convert from a COLORREF value to a TColor value, cast the COLORREF value to a TColor type.
See Also