AnnTextExpandTokens property (ILEADRasterAnnotation)

Visual Basic example

Visual C++ 5.0 example

 

Syntax

VARIANT_BOOL AnnTextExpandTokens (long hObject);

Overview

Refer to Implementing Annotations.

Remarks

Indicates whether the annotation object's text tokens will expand. Possible values are:

Setting

Description

VARIANT_TRUE

Text tokens will be expanded for this object.

VARIANT_FALSE

Text tokens will not be expanded for this object.

This property is valid only for the following annotation objects:

image\sqrblit.gif ANN_OBJECT_AUTOMATION

image\sqrblit.gif ANN_OBJECT_BUTTON

image\sqrblit.gif ANN_OBJECT_NOTE

image\sqrblit.gif ANN_OBJECT_PUSHPIN

image\sqrblit.gif ANN_OBJECT_STAMP

image\sqrblit.gif ANN_OBJECT_TEXT

image\sqrblit.gif ANN_OBJECT_TEXTPOINTER

Getting or setting this property for an annotation object other than ones listed above will set an error in the AnnError property.

If this property is VARIANT_TRUE, then all tokens will be expanded.

For example, if you have an ANN_OBJECT_BUTTON object that will expand text tokens, and #D is defined to be the current day of the week (ANN_TOKEN_DATE_DAY_OF_WEEK), then entering #D for the text of this button will cause it to display the current day of the week when in design or run mode.

You must set the Flags property before setting this property. Possible values for the Flags property, when used with this property are:

0

ANN_FLAG_SELECTED

ANN_FLAG_NOTTHIS

ANN_FLAG_RECURSE

ANN_FLAG_NOTCONTAINER

ANN_FLAG_NOINVALIDATE

ANN_FLAG_CHECKMENU

See Also

Elements:

Flags property, AnnClearTokenTable method, AnnDeleteTokenTable method, AnnEnumerateTextToken method, AnnInsertTokenTable method

Topics:

Annotations (Document/Medical only): Object Manipulation