LAnnLine::EnumHandleCallBack (original) (raw)
Summary
Processes each annotation object from the LAnnLine::EnumerateHandles function.
Syntax
#include "ltwrappr.h"
virtual L_INT LAnnLine::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 LAnnLine::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 LAnnLine::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 LAnnLine::EnumHandleCallBack you must call LBase::EnableCallBack before calling LAnnLine::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.
See Also
Functions
- LAnnLine::AddUserHandle
- LAnnLine::EnumerateHandles
- LAnnLine::GetUserHandle
- LAnnLine::GetUserHandles
- LAnnLine::ChangeUserHandle
- LAnnLine::DeleteUserHandle
- LAnnContainer::Convert
- LAnnContainer::HitTest
- LAnnContainer::RestrictCursor
- LAnnotation::GetRestrictToContainer
- LAnnotation::SetRestrictToContainer
- LAnnotation::Define2
- LAnnotation::Define
- Class Members
Topics
- Annotation Functions: Object Properties
- Implementing Annotations
- Automated User Interface for Annotations
- Annotation Functions: Creating and Deleting Annotations
- Types of Annotations
- Annotation Functions: Implementing Custom Annotations
- Annotation Functions: Creating Custom Annotations
Example
For an example, refer to LAnnLine::EnumerateHandles.
LEADTOOLS Raster Imaging C++ Class Library Help