L_AnnGetAutoBackColor

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoBackColor(hObject, uObjectType, pcrBack)

HANNOBJECT hObject;	/* handle to the annotation object */
L_UINT uObjectType;	/* object type */
COLORREF *pcrBack;	/* pointer to a variable to be updated */

Gets the background color of one or more annotation objects.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
uObjectType	Type of object for which to get the background color. For a list of possible values, refer to Types of Annotations.
pcrBack	Pointer to a COLORREF variable to be updated with the background color of the specified object type.

Returns

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

Comments

Please note the following:

if uObjectType 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.

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 2000 / XP/Vista.

See Also

Functions:	L_AnnSetAutoBackColor, L_AnnGetBackColor, L_AnnSetBackColor, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor, L_AnnGetFillMode, L_AnnSetFillMode, L_AnnGetOptions, L_AnnSetOptions
Topics:	Changing the Annotation Automation Background Colors
	Obtaining Annotation Object Information
	Annotation Functions (Document/Medical only): Automation Properties
	Using Color Values in LEADTOOLS

Example

This example will rotate the colors through all the object types.

 L_INT AnnGetAutoBackColorExample(HANNOBJECT hAutomation)
{
   L_INT nRet;
   COLORREF crColor1, crColor2;

   nRet = L_AnnGetAutoBackColor(hAutomation, ANNOBJECT_NOTE, &crColor2);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_AnnGetAutoBackColor(hAutomation, ANNOBJECT_HILITE, &crColor1);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnSetAutoBackColor(hAutomation, ANNOBJECT_NOTE, crColor1);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_AnnGetAutoBackColor(hAutomation, ANNOBJECT_REDACT, &crColor1);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnSetAutoBackColor(hAutomation, ANNOBJECT_HILITE, crColor1);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_AnnGetAutoBackColor(hAutomation, ANNOBJECT_TEXT, &crColor1);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnSetAutoBackColor(hAutomation, ANNOBJECT_REDACT, crColor1);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_AnnSetAutoBackColor(hAutomation, ANNOBJECT_TEXT, crColor2);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}