In This Topic ▼

LAnnRTF::EnumHandleCallBack

Summary

Processes each annotation object from the LAnnRTF::EnumerateHandles function.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnRTF::EnumHandleCallBack(hObject, pHandleInfo)

Parameters

HANNOBJECT hObject

Handle of the annotation object being processed.

pANNHANDLEINFO pHandleInfo

Pointer to structure that contains information about the annotation object handle.

Returns

Value	Meaning
SUCCESS_CHANGE	[1] Change the object
SUCCESS_NOCHANGE	[2] Do not change the object

Comments

The LAnnRTF::EnumerateHandles function calls your callback function for each handle of a single annotation object.

The pHandleInfo structure can be used to obtain detailed information about an annotation object handle. It can also be used to change some (but not all) of the properties of a user handle. All properties of an annotation object handle can be changed EXCEPT the location. The properties of a node that can be changed with this function are:

ID
Visibility
Pen color
Fill color
Shape
Cursor

To change the location of a user-defined node, use LAnnRTF::ChangeUserHandle.

To change the properties of an annotation object handle, set the corresponding field in the pHandleInfo structure, and return SUCCESS_CHANGED. To leave the handle properties unchanged, return SUCCESS_UNCHANGED.

To enable the LAnnRTF::EnumHandleCallBack you must call LBase::EnableCallBack before calling LAnnRTF::EnumerateHandles function.

For more information, refer to ANNHANDLEINFO.