LAnnotation::GetTextOptions (original) (raw)
Summary
Sets the text options for the annotation object.
Syntax
#include "ltwrappr.h"
L_INT LAnnotation::GetTextOptions(pTextOptions, uStructSize)
Parameters
pANNTEXTOPTIONS pTextOptions
Pointer to an ANNTEXTOPTIONS structure that specifies the text options to set.
L_UINT uStructSize
Size in bytes, of the structure pointed to by pTextOptions, for versioning. Use sizeof(ANNTEXTOPTIONS).
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
Use this function to get the text options of a text annotation object. If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the LAnnotation::GetTextOptions and the LAnnotation::SetTextOptions functions to set the objects to show or hide the text and to set the color of the text. In addition, if the annotation objects are text or stamp objects these functions can set the objects to show or hide the borders of the object. These features must be enabled using the LAnnotation::SetOptions function. To use this function, declare a variable of type ANNTEXTOPTIONS, and pass the address of this variable as the second argument. For more information, refer to the documentation for the structure ANNTEXTOPTIONS.
The class object parameter can represent any annotation object type, but the return information is only useful for text annotations.
Note: Enable this function by calling LAnnotation::SetOptions with the OPTIONS_NEW_TEXT_OPTIONS flag.
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
- LAnnotation::SetTextOptions
- LAnnAutomation::SetText
- LAnnAutomation::GetText
- LAnnAutomation::GetTextLen
- LAnnAutomation::SetTextAlign
- LAnnAutomation::GetTextAlign
- LAnnAutomation::SetTextRotate
- LAnnAutomation::GetTextRotate
- LAnnotation::GetOptions
- LAnnotation::SetOptions
Topics
- Key Annotation Features
- Annotation Functions: Object Properties
- Annotation Functions: Getting and Setting Text Properties
- User Interface for Container and Automation Objects
- Displaying and Manipulating Annotation Objects
- Annotation Functions: Object Information
- Container Annotation Object
- Annotation Automation Object
- Text Annotation Object
- Text Pointer Annotation Object
- Stamp Annotation Object
- Note Annotation Object
- Pushpin Annotation Object
- Button Annotation Object
Example
For an example, refer to LAnnotation::SetTextOptions.
LEADTOOLS Raster Imaging C++ Class Library Help