L_AnnGetTextFixedSize
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetTextFixedSize (hObject, pbTextFixedSize)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
L_BOOL *pbTextFixedSize; |
/* pointer to a variable to be updated */ |
Gets a value that indicates whether the text size changes with scaling.
This function is available in the Document and Medical Imaging toolkits.
Parameter |
Description |
|
hObject |
Handle to the annotation object |
|
pbTextFixedSize |
Pointer to a variable to be updated with a value that indicates whether the text size changes with scaling. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The text size does not change with scaling. |
|
FALSE |
The text size changes with scaling. This is the default value. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The text size of an object is relative to its container object, and the value is interpreted using the container's scaling factors. As a result, when zooming in the text size increases, and when zooming out the text size decreases. This is the default behavior.
In some cases it might be preferable to have the text size of an annotation object remain constant, regardless of the scaling (zooming). To do this, call L_AnnSetTextFixedSize function with the bTextFixedSize parameter set to TRUE.
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 2000 / XP/Vista.
See Also
Example
For an example, refer to L_AnnSetTextFixedSize.