LEADTOOLS Raster Imaging C DLL Help
| LEADTOOLS Raster Imaging C DLL Help > Function References > L_AnnSetTextAlign |
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnSetTextAlign(hObject, uTextAlign, uFlags)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
L_UINT uTextAlign; |
/* flag that specifies the object's text alignment */ |
|
L_UINT uFlags; |
/* flags that determine which objects to process */ |
Sets the text alignment of an annotation.
|
Parameter |
Description |
|
|
hObject |
Handle to the annotation object. |
|
|
uTextAlign |
Value that indicates the object's text alignment. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TEXTALIGN_LEFT |
[1] Align text to left. |
|
|
TEXTALIGN_CENTER |
[2] Center the text. |
|
|
TEXTALIGN_RIGHT |
[3] Align text to the right. |
|
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 L_AnnGetSelected and L_AnnSetSelected 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_TEXT menu item has been selected. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function sets the text alignment of certain annotation objects that display text. The function is valid only for the following annotation objects:
ANNOBJECT_AUTOMATION
ANNOBJECT_NOTE
ANNOBJECT_TEXT
ANNOBJECT_TEXTPOINTER
Calling this function on an object other than those listed above will return ERROR_FEATURE_NOT_SUPPORTED.
Required DLLs and Libraries
|
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_AnnGetTextAlign, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Text Properties |
Example
For an example, refer to L_AnnGetTextAlign.
