LAnnRuler::EnumerateHandles

Summary

Calls the LAnnRuler::EnumHandleCallBack function for ALL handles (both default and user-defined) for an annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnRuler::EnumerateHandles()

Returns

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

Comments

Use this function to get information about all annotation handles for an annotation object.

Note that this function returns information about both default annotation handles and user-defined annotation handles.

This function can also be used to change some of the properties of an annotation handle.

For more information, refer to the LAnnRuler::EnumHandleCallBack function.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

/*<struct>*/ 
#if defined(MyAnnRuler) 
class MyAnnRuler: public LAnnRuler 
{ 
public:  
   virtual L_INT EnumHandleCallBack(HANNOBJECT hObject, pANNHANDLEINFO pHandleInfo);  
}; 
#endif 
/*</struct>*/ 
L_INT MyAnnRuler::EnumHandleCallBack(HANNOBJECT hObject, pANNHANDLEINFO pHandleInfo)  
{ 
	UNREFERENCED_PARAMETER(hObject); 
 
   pHandleInfo->bVisible = TRUE;  
   if (pHandleInfo->nType == ANNHANDLETYPE_DEFAULT_HANDLE)  
   { 
      pHandleInfo->nShape = ANNHANDLE_SHAPE_SQUARE;  
      pHandleInfo->crFill = RGB(0,0,255);  
   } 
   else 
   { 
      pHandleInfo->nShape = ANNHANDLE_SHAPE_CIRCLE;  
      pHandleInfo->crFill = RGB(0,255,0);  
   } 
   return SUCCESS_CHANGE;  
} 
 
L_INT LAnnRuler_EnumerateHandlesExample(MyAnnRuler *LRuler)  
{ 
	L_INT nRet; 
 
   LRuler->EnableCallBack(TRUE);  
 
   nRet = LRuler->EnumerateHandles(); 
	if(nRet != SUCCESS) 
		return nRet; 
 
	return SUCCESS; 
} 
Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.