L_AnnSetTextRotate (original) (raw)
Summary
Sets a value that indicates whether the text of an annotation object is rotated.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnSetTextRotate(hObject, uTextRotate, uFlags)
Parameters
HANNOBJECT hObject
Handle to the annotation object.
L_UINT uTextRotate
Value that indicates whether the text of an annotation object is rotated, and if so, then by how many degrees. Possible values are:
| Value | Meaning |
|---|---|
| TEXTROTATE_0 | [0] Do not rotate the text. |
| TEXTROTATE_90 | [90] Rotate the text 90 degrees counter clockwise. |
| TEXTROTATE_180 | [180] Rotate the text 180 degrees counter clockwise. |
| TEXTROTATE_270 | [270] Rotate the text 270 degrees counter clockwise. |
L_UINT 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
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
This function sets a value that indicates whether the text of certain annotation objects that display text will be rotated. The function is valid only for the following annotation objects:
- ANNOBJECT_AUTOMATION
- ANNOBJECT_NOTE
- ANNOBJECT_TEXTPOINTER
Calling this function on an object other than those listed above will return ERROR_FEATURE_NOT_SUPPORTED. Note that the ANNOBJECT_TEXT object does not support text rotation because it can be rotated ANY angle by calling L_AnnRotate.
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
Topics
- Annotation Functions: Object Properties
- Annotation Objects - Default Values
- Annotation Objects - Automated Features
- Implementing an Automated Annotation Program
- Implementing a Non-automated Annotation Program
- Altering Annotation Object Settings
- Annotation Functions (Document/Medical only): Text Properties
Example
For an example, refer to L_AnnGetTextRotate.
LEADTOOLS Raster Imaging C API Help