LAnnotation::GetAutoBackColor
#include "ltwrappr.h"
virtual L_INT LAnnotation::GetAutoBackColor(uObjectType, pcrBack)
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/Medical Toolkits.
Parameter |
Description |
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. |
See Also
Example
L_INT LAnnotation_GetAutoBackColorExample() { L_INT nRet; // This example will rotate the colors through all the object types. COLORREF crColor1, crColor2; LAnnotation lAutomation; nRet = lAutomation.GetAutoBackColor(ANNOBJECT_NOTE, &crColor2); if(nRet != SUCCESS) return nRet; nRet = lAutomation.GetAutoBackColor(ANNOBJECT_HILITE, &crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.SetAutoBackColor(ANNOBJECT_NOTE, crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.GetAutoBackColor(ANNOBJECT_REDACT, &crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.SetAutoBackColor(ANNOBJECT_HILITE, crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.GetAutoBackColor(ANNOBJECT_TEXT, &crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.SetAutoBackColor(ANNOBJECT_REDACT, crColor1); if(nRet != SUCCESS) return nRet; nRet = lAutomation.SetAutoBackColor(ANNOBJECT_TEXT, crColor2); if(nRet != SUCCESS) return nRet; return SUCCESS; }