ANNTEXTOPTIONS

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, *pANNTEXTOPTIONS; 

Provides information about the text options for text annotation objects, including the Automation object.

Members

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:

bShowText

Boolean value that indicates whether you want to show the text. Possible values are:

bShowBorder

Boolean value that indicates whether you want to show the border. Possible values are:

crText

A COLORREF value that represents the color to be used for the text.

nReserved

A COLORREF value that represents the color to be used for the background text in the ANNOBJECT_RTF.

Comments

The ANNTEXTOPTIONS structure is used with the L_AnnSetTextOptions and L_AnnGetTextOptions 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 these 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 L_AnnSetOptions function before they can be used.

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

• ANNOBJECT_CONTAINER
• ANNOBJECT_AUTOMATION
• ANNOBJECT_TEXT
• ANNOBJECT_BUTTON
• ANNOBJECT_NOTE
• ANNOBJECT_STAMP
• ANNOBJECT_PUSHPIN
• ANNOBJECT_TEXTPOINTER

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

• ANNOBJECT_TEXT
• ANNOBJECT_STAMP

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

This function can also be used to change to properties of an ANNOBJECT_RTF.

To change the text foreground color of an ANNOBJECT_RTF:

• include these flags: (ANNTEXT_RTF | ANNTEXT_TEXTCOLOR)
• set the crText member to the desired text foreground color

To change the text background color of an ANNOBJECT_RTF:

• include these flags: (ANNTEXT_RTF | ANNTEXT_TEXTBACKCOLOR)
• set the nReserved member to the desired text background color

To disable drawing of the border of an ANNOBJECT_RTF:

• include these flags: (ANNTEXT_RTF | ANNTEXT_SHOW_BORDER)
• set the bShowBorder member to FALSE

Example

For an example, refer to L_AnnGetTextOptions