L_AnnGetShowStampBorder
#include "l_bitmap.h"
L_LTANN_API L_INT EXT_FUNCTION L_AnnGetShowStampBorder(hObject, pbShowStampBorder)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
L_BOOL * pbShowStampBorder; |
/* address of the variable to be updated*/ |
Gets a value indicating whether the bitmap stamp is displayed with a border. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
hObject |
Handle of the annotation object. |
|
|
pbShowStampBorder |
Address of the variable to be updated with a value indicating whether the stamp object is displayed with a border. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TRUE |
Show the border |
|
|
FALSE |
Do not show the border. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Gets a value indicating whether the annotation stamp object (ANNOBJECT_STAMP) is displayed with a border. The L_AnnGetShowStampBorder function is valid only for the following object types when they are using a bitmap or a metafile:
Stamp (including the Rubber Stamp tools)
In addition, the Automation object stores this setting along with the other object default settings.
Call the L_AnnSetShowStampBorder function to set such objects to display a border. By default the border color is red (0x00FF0000). Call the L_AnnSetForeColor function to set the border color. Call the L_AnnSetLineWidth function to set the border width. By default the border width is .075 points.
Note that the ANNOBJECT_STAMP can display text, a bitmap, or a metafile. If the stamp contains a bitmap or a metafile, use L_AnnSetShowStampBorder to show or hide the border. If the stamp contains text, use L_AnnSetTextOptions to show or hide the border.
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
Windows 95 / 98 / Me, Windows 2000 / XP, Windows CE.
See Also
|
Functions: |
L_AnnSetShowStampBorder, L_AnnGetTextOptions, L_AnnSetTextOptions, L_AnnSetBitmap, L_AnnSetMetafile |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
For an example, refer to L_AnnSetShowStampBorder.