L_AnnSetForeColor

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetForeColor(hObject, crFore, uFlags)

Sets the foreground color of one or more annotation objects. The default foreground color is red.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

COLORREF crFore

The COLORREF value that specifies the foreground color.

L_UINT uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. 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 L_AnnGetSelected and L_AnnSetSelected 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_FOREGROUNDCOLOR menu item has been selected.

Returns

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

Comments

You use the Windows COLORREF data type to specify the color. For example, you can use the L_GetPixelColor function or the Windows RGB macro to get a color value.

This function applies to multiple and selected objects based on values of the uFlags parameter.

To see how the foreground color relates to the fill modes, refer to Illustration of Fill Options for Annotations.

This function 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.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For complete sample code, refer to the Annotate example.

L_INT AnnSetForeColorExample(HANNOBJECT hAnnObject) 
{ 
   L_INT nRet; 
   COLORREF ThisColor; /* Object foreground color */ 
 
   /* Invert the foreground color */ 
   nRet = L_AnnGetForeColor(hAnnObject, &ThisColor); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnSetForeColor (hAnnObject, ThisColor ^ 0x00FFFFFF, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 

Help Version 20.0.2019.9.22
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help