In This Topic ▼

LAnnContainer::SetBackColor

✎ NOTE

THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Summary

Sets the background color of the annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnContainer::SetBackColor(crBack=RGB(0,0,0), uFlags=0)

Parameters

COLORREF crBack

The COLORREF value that specifies the background 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 LAnnContainer::GetSelectItems 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.

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 LBitmapBase::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 background 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

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

L_INT LAnnContainer_SetBackColorExample(LAnnContainer  * pAnnContainer) 
{ 
   L_INT nRet; 
 
   nRet = pAnnContainer->SetBackColor(RGB(200,200,120)); 
 
   return nRet; 
}

Download our FREE evaluation

Help Version 22.0.2023.2.2