LAnnContainerANNTEXTOPTIONS (Document/Medical only)
typedef struct tagANNTEXTOPTIONS
{
L_UINT uStructSize;
// size of this structure
L_UINT uFlags;
L_BOOL bShowText; //
TRUE if you want to show the text
L_BOOL bShowBorder;
// TRUE if you want to show the border
COLORREF crText;
L_INT32 nReserved;
} ANNTEXTOPTIONS, L_FAR* pANNTEXTOPTIONS;
The ANNTEXTOPTIONS structure provides information about the text options for text annotation objects, including the automation object.
|
Member |
Description |
|
|
uStructSize |
Size of this structure. Use sizeof(ANNTEXTOPTIONS) |
|
|
uFlags |
Flags that identify which fields are valid. Possible values are one or more of the following constants "or"ed together. Possible values are: |
|
|
|
Value |
Meaning |
|
|
ANNTEXT_SHOW_TEXT (0x001) |
The bShowText field is valid |
|
|
ANNTEXT_SHOW_BORDER (0x002) |
The bShowBorder field is valid |
|
|
ANNTEXT_TEXTCOLOR (0x002) |
The crText field is valid |
|
|
ANNTEXT_ALL |
Logical or of all above flags |
|
bShowText |
Boolean value that indicates whether you want to show the text. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TRUE |
Show the text. |
|
|
FALSE |
Do not show the text. |
|
bShowBorder |
Boolean value that indicates whether you want to show the border. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TRUE |
Show the border. |
|
|
FALSE |
Do not show the border. |
|
crText |
A COLORREF value that represents the color to be used for the text. |
|
|
nReserved |
Reserved for future use. Use zero. |
|
Comments
The ANNTEXTOPTIONS structure is used with the LAnnotation::SetTextOptions and the LAnnotation::GetTextOptions functions to get or set the text options for text annotation objects, including the Automation 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. In version 14.5, note that these features must be enabled using the LAnnotation::SetOptions function.
When calling the LAnnotation::GetTextOptions function, the uFlags field identifies which fields to retrieve. When calling the LAnnotation::SetTextOptions function, the uFlags field identifies which fields to set.
When you create an object in the automation mode, the values for bShowText, bShowBorder, and crText are taken from the Automation object.
The default value for bShowText is TRUE, which means that text objects will show text. The default value for crText is red (RGB(255,0,0). This flag applies to all text objects including:
LAnnContainer
LAnnAutomation
LAnnText
LAnnTextPointer
LAnnStamp
LAnnNote
LAnnPushPin
LAnnButton
The default value for bShowBorder is TRUE. This flag affects the following objects:
LAnnText
LAnnStamp