L_AnnGetFillMode (original) (raw)

Summary

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

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetFillMode(hObject, puFillMode, pnAlpha)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_UINT * puFillMode

Pointer to a variable to be updated with the object's fill mode constant. Possible fill mode values are:

L_INT * pnAlpha

Pointer to a variable to be updated with the objects alpha value. This is only valid if the fill mode puFillMode is updated with is ANNMODE_ALPHA. Possible values range from 0 255 where:

Returns

Comments

You can use this function to get the fill mode settings for annotation objects.

Before calling L_AnnGetFillMode enable alpha background filling. You can enable alpha background filling by using the following code snippet:

L_VOID ExampleEnableOption(HANNOBJECT hAutomation) { L_UINT uOptions = 0; L_AnnGetOptions( hAutomation); L_AnnSetOptions( hAutomation, uOptions | OPTIONS_NEW_ALPHA); }

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

Before calling this function, you must declare a variable of data type L_UINT. Then, pass the address of the variable in the puFillMode parameter. This function will update the variable with the annotation object's fill mode constant. If the returned fill mode is ANNMODE_ALPHA, then there is also a corresponding alpha value (0..255). To get the alpha value, declare a variable of type L_INT and pass the address for the puAlpha value. If you do not want the alpha value, pass NULL for the puAlpha value. Note that if the returned fill mode is anything other than ANNMODE_ALPHA, then there is no corresponding alpha value.

The ANNMODE_ALPHA parameter allows you to declare the amount of transparency of the annotation background. The alpha value can be between 0 (completely transparent) and 255 (completely opaque) inclusive.

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

Note that the L_AnnSetROP2 function and the L_AnnSetFillMode function affect each other. If you set uFillMode to:

• ANNFILLMODE_OPAQUE, then uROP2 cannot be ANNROP2_AND.
• ANNFILLMODE_TRANSLUCENT, then uROP2 has to be ANNROP2_AND.
• ANNFILLMODE_TRANSPARENT, then uROP2 can be anything.

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.

See Also

Functions

• L_AnnSetFillMode
• L_AnnSetFillPattern
• L_AnnGetFillPattern
• L_AnnGetPolyFillMode
• L_AnnSetPolyFillMode
• L_AnnGetROP2
• L_AnnSetROP2
• L_AnnSetBackColor
• L_AnnSetForeColor

Topics

• Annotation Features
• Annotation Functions (Document/Medical only) Displaying Annotations
• Annotation Functions: Object Information
• Implementing Annotations
• Obtaining Annotation Object Information
• Altering Annotation Object Settings
• Illustration of Fill Options for Annotations
• User Interface for Container and Automation Objects
• Displaying and Manipulating Annotation Objects
• Container Annotation Object
• Annotation Automation Object
• Annotation Functions (Document/Medical only): Getting and Setting Color Properties
• Annotation Functions (Document/Medical only): Getting and Setting the Alpha Property

Example

For an example, refer to L_AnnSetFillMode.

LEADTOOLS Raster Imaging C API Help