L_INT LAnnotation::GetFillMode(puFillMode, pnAlpha)
Gets the fill mode and alpha of the specified annotation object.
Pointer to a variable to be updated with the object's fill mode constant. Possible fill mode values are:
Value | Meaning |
---|---|
ANNMODE_TRANSPARENT | [0] Transparent |
ANNMODE_TRANSLUCENT | [1] Translucent |
ANNMODE_OPAQUE | [2] Opaque |
ANNMODE_ALPHA | [3] Alpha |
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 to 255 where:
Value | Meaning |
---|---|
0 | Transparent background. |
255 | Opaque background. |
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Use this function to get the fill mode settings for annotation objects.
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 pnAlpha value. If you do not want the alpha value, pass NULL for the pnAlpha 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 LAnnotation::SetROP2 function and the LAnnotation::SetFillMode function affect each other. If you set uFillMode to ANNFILLMODE_OPAQUE, then uROP2 cannot be ANNROP2_AND. If you set uFillMode to ANNFILLMODE_TRANSLUCENT, then uROP2 has to be ANNROP2_AND. If you set uFillMode to ANNFILLMODE_TRANSPARENT, uROP2 can be anything.
Win32, x64.
For an example, refer to LAnnotation::SetNameOptions.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document