AnnGetAutoBackColor method (Annotation Control)

C++ Builder example

Delphi example

 

Builder Syntax

int AnnGetAutoBackColor(HANNOBJECT hObject, int nType, TColor &clBack)

Delphi Syntax

Function AnnGetAutoBackColor (hObject: HANNOBJECT; nType: L_INT; var clBack: TColor): L_INT

Overview

Refer to Implementing Annotations.

Remarks

(Document/Medical only) Gets the background color of one or more annotation objects.

Please note the following:

If nType is:

Then the background color retrieved is:

ANNOBJECT_NOTE or ANNOBJECT_PUSHPIN

The background color used for Note objects and Push pin objects created by the Automation object.

ANNOBJECT_HILITE

The background color used for Hilite objects created by the Automation object.

ANNOBJECT_REDACT

The background color used for Redact objects created by the Automation object.

any other object such as ANNOBJECT_TEXT, ANNOBJECT_RECT, etc.

The background color used for 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

Elements

AnnSetForeColor method, AnnGetForeColor method, AnnSetBackColor method, AnnGetBackColor method, AnnSetAutoBackColor method

Topics

Annotations (Document/Medical only): Implementing Automation

 

Annotations (Document/Medical only): Getting and Setting Color Properties

 

Obtaining Annotation Object Information

 

Using Color Values in LEADTOOLS