L_AnnSetTextExpandTokens

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetTextExpandTokens(hObject, bTextExpandTokens, uFlags)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL bTextExpandTokens;	/* value that specifies whether text tokens will be expanded */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets a value that indicates whether the text tokens will be expanded for the specified annotation object.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
bTextExpandTokens	Value that specifies whether the text tokens will be expanded for this object. Possible values are:
	Value	Meaning
	TRUE	Text tokens will be expanded for this object.
	FALSE	Text tokens will not be expanded for this object.

uFlags	Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( \| ). The following are valid values:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
	ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_TEXT menu item has been selected.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The function is valid only for the following annotation objects:

ANNOBJECT_AUTOMATION

ANNOBJECT_BUTTON

ANNOBJECT_NOTE

ANNOBJECT_PUSHPIN

ANNOBJECT_STAMP

ANNOBJECT_TEXT

ANNOBJECT_TEXTPOINTER

Calling this function on an object other than those listed above will return ERROR_FEATURE_NOT_SUPPORTED.

If bTextExpandTokens is set to TRUE, then all tokens will be expanded.

For Example, if you have an ANNOBJECT_BUTTON object that will expand text tokens, and #D is defined to be the current day of the week (ANNTOKEN_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.

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

Windows 2000 / XP/Vista.

Functions:	L_AnnClearTextTokenTable, L_AnnDeleteTextTokenTable, L_AnnEnumerateTextTokenTable, L_AnnGetTextExpandTokens, L_AnnInsertTextTokenTable, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	The Annotation Text Token Table
	Altering Annotation Object Settings
	Annotation Functions (Document/Medical only): Text Properties