In This Topic ▼

LAnnotation::SetFillMode

Summary

Sets the fill mode and alpha of the specified annotation object.

Syntax

#include "ltwrappr.h"

L_INT LAnnotation::SetFillMode(uFillMode, nAlpha, uFlags)

Parameters

L_UINT uFillMode

The constant that specifies the object's fill mode. Possible fill mode values are:

Value	Meaning
ANNMODE_TRANSPARENT	[0] Transparent
ANNMODE_TRANSLUCENT	[1] Translucent
ANNMODE_OPAQUE	[2] Opaque
ANNMODE_ALPHA	[3] Alpha

L_INT nAlpha

Value that specifies the objects alpha value. This is only valid if uFillMode is ANNMODE_ALPHA. Possible values are: -1..255. For an explanation of these values, refer to the Comments section below.

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 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_FILL menu item has been selected.

Returns

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

Comments

You can use this function to set the fill mode for annotation objects. the LAnnotation::SetFillMode function.

The following figure displays rectangle annotation objects using different alpha values:

$image\alpha.gif$

The nAlpha parameter is used only if the uFillMode parameter is passed as ANNMODE_ALPHA, in which case, nAlpha can be between -1 and 255 inclusive. Values are used as follows:

a value of -1 means to leave the existing nAlpha value unchanged.

a value of 0 means the annotation object background is completely transparent.

a value of 255 means the annotation background is completely opaque.

any value between 0 and 255 can be used to specify a varying degree of transparency.

Note that the LAnnotation::SetROP2 function and the LAnnotation::SetFillMode function affect each other.

If you set uFillMode to	then uROP2
ANNFILLMODE_OPAQUE	cannot be ANNROP2_AND
ANNFILLMODE_TRANSLUCENT	has to be ANNROP2_AND
ANNFILLMODE_TRANSPARENT	can be anything

To see the possible fill modes and patterns, refer to Illustration of Fill Options for Annotations.

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

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.