In This Topic ▼

LAnnAutomation::SetTransparentColor

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetTransparentColor(crTransparent, uFlags=0)

Sets the transparent color.

Parameters

COLORREF crTransparent

The fill color. The standard Windows values for COLORREF represent either red, green, and blue color values, or an index into the bitmap's palette. A COLORREF value with the format 0x00BBGGRR represents the blue, green, and red color values for the specified pixel, where 0xBB is the blue value, 0xGG is the green value and 0xRR is the red value. If 0x01000000 is set in the COLORREF value (0x010000ZZ), the lower 8 bits (0xZZ) represent an index into the bitmap's palette, which holds the color value. These COLORREF values can be used with any Windows function and macro that takes a COLORREF parameter.

In Document/Medical toolkits, the COLORREF value may represent a 16 bit grayscale value if pBitmap is a 12 or 16-bit grayscale bitmap. So that the value is not confused with an RGB value, the COLORREF_GRAY16 mask (0x04000000) is set. In this case (0x0400YYYY), the lower 16 bits (0xYYYY) of the COLORREF value represent the 16-bit grayscale value. (0x0400FFFF is 16-bit white and 0x04000000is 16-bit black.) This is not a standard Windows value. Therefore, LEADTOOLS functions will recognize a COLORREF having this format, but Windows functions will not. For information on how to use a 16-bit grayscale COLORREF in a non-LEADTOOLS function, refer to LBitmapBase::GetPixelColor.

L_UINT uFlags

Flags that determine which objects to process. You can combine values when appropriate by using a bitwise OR (|). The following are valid values:

Value	Meaning
0	Process only the specified object.
ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_TRANSPARENTCOLOR menu item has been selected.

Returns

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

Comments

Only Point and Stamp objects that are using a bitmap can be set to use a transparent color.

This transparent color is used only if the object is set to transparent using the LAnnAutomation::SetTransparentfunction.

By default, the transparent color is white (0x00FFFFFF).

All objects created by this automation object will have this transparent color.

In design mode, the transparent color can be picked by selecting the Transparent color from the properties menu. If the objects bitmap has a palette, a dialog box will come up allowing you to select a color from the palette colors. If the objects bitmap does not have a palette, the standard Windows color pick dialog box is used to select a transparent color.

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

Win32, x64.

Example

This example uses the following member variables:
m_AnnotationWindow should be created and initialized prior to the example

L_INT LAnnAutomation_SetTransparentColorExample(LAnnotationWindow m_AnnotationWindow)  
{  
   L_INT nRet; 
   COLORREF ColorRef; 
 
   L_TCHAR szTemp[100]; 
 
   nRet = m_AnnotationWindow.GetAutomationObject().SetTransparentColor(RGB(255,0,0)); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = m_AnnotationWindow.GetAutomationObject().SetTransparent(TRUE); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = m_AnnotationWindow.GetAutomationObject().GetTransparentColor(&ColorRef); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szTemp,TEXT("Transparent Color: %x"),ColorRef); 
 
   AfxMessageBox(szTemp);  
 
   return SUCCESS; 
}