LAnnHotSpot::EnumerateHandles

#include "ltwrappr.h"

virtual L_INT LAnnHotSpot::EnumerateHandles()

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

Returns

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 LAnnHotSpot::EnumHandleCallBack function.

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:

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

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

 

Annotation Functions: Working with the Toolbar

Example

/*<struct>*/
#if defined(MyAnnHotSpot)
class MyAnnHotSpot: public LAnnHotSpot
{
   public: 
      virtual L_INT EnumHandleCallBack(HANNOBJECT hObject, pANNHANDLEINFO pHandleInfo); 
};
#endif
/*</struct>*/
L_INT MyAnnHotSpot::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 LAnnHotSpot_EnumerateHandlesExample(MyAnnHotSpot *LHotSpot) 
{
   L_INT nRet;
   nRet = LHotSpot->EnableCallBack(TRUE); 
   if(nRet != SUCCESS)
      return nRet;
   nRet = LHotSpot->EnumerateHandles();
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}