LAnnRedact::EnumHandleCallBack

#include "ltwrappr.h"

virtual L_INT LAnnRedact::EnumHandleCallBack(hObject, pHandleInfo)

HANNOBJECT hObject;

handle to the annotation object

pANNHANDLEINFO pHandleInfo;

pointer to structure containing information about the annotation object handle

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

Parameter

Description

hObject

Handle of the annotation object being processed.

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 LAnnRedact::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 LAnnRedact::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 LAnnRedact::EnumHandleCallBack you must call LBase::EnableCallBack before calling LAnnRedact::EnumerateHandles function.

For more information, refer to the documentation for ANNHANDLEINFO.

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

Win32, x64.

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C++ Class Library Help