ANNTEXTOPTIONS (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;

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, or to execute an operation that does not depend on a field. 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 L_AnnSetTextOptions and the L_AnnGetTextOptions functions to get or set the text options for text annotation objects, including the Automation object.

When calling the L_AnnGetTextOptions function, the uFlags field identifies which fields to retrieve. When calling the L_AnnSetTextOptions 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:

image\sqrblit.gif ANNOBJECT_CONTAINER

image\sqrblit.gif ANNOBJECT_AUTOMATION

image\sqrblit.gif ANNOBJECT_TEXT

image\sqrblit.gif ANNOBJECT_BUTTON

image\sqrblit.gif ANNOBJECT_NOTE

image\sqrblit.gif ANNOBJECT_TEXT

image\sqrblit.gif ANNOBJECT_STAMP

image\sqrblit.gif ANNOBJECT_PUSHPIN

image\sqrblit.gif ANNOBJECT_TEXTPOINTER

The default value for bShowBorder is TRUE. This flag affects the following objects:

image\sqrblit.gif ANNOBJECT_TEXT

image\sqrblit.gif ANNOBJECT_STAMP

These values can be changed through automation by right clicking the object, and choosing Properties->Text.

Note that in version 14.5, the L_AnnSetTextOptions function and the L_AnnGetTextOptions function must first be enabled using the L_AnnSetOptions function before they can be used.

Example

For an example, refer to L_AnnGetTextOptions.