L_AnnAddUserHandle

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnAddUserHandle(hObject, pAnnHandle)

Adds a user-defined handle to an annotation object, where pAnnHandle is a pointer to the structure defining an annotation handle.

Parameters

HANNOBJECT hObject

Handle to the annotation object to which to add the user handle.

pANNHANDLE pAnnHandle

Pointer to a structure that defines the user handle.

Returns

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

Comments

Before calling this function, you must create the annotation object.

Call this function one or more times to add user handles to an existing annotation object.

The user handle location can be defined using container coordinates or client coordinates.

Client coordinates factor in the current zoom factor, and the horizontal and vertical scrolling.

For more information on defining a user handle, see the documentation for the ANNHANDLE structure.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

This example adds user handles to the center of the top and bottom lines of a rectangle.

// hRect is a rectangle. 
L_INT AnnAddUserHandleExample(HANNOBJECT hRect) 
{ 
   L_INT nRet; 
   ANNHANDLE   AnnHandle; 
   L_UINT      uType; 
   ANNRECT     arc; 
 
   nRet = L_AnnGetType(hRect, &uType); 
   if(nRet != SUCCESS) 
      return nRet; 
   if (uType == ANNOBJECT_RECT) 
   { 
      nRet = L_AnnGetRect(hRect, &arc, NULL); 
      if(nRet != SUCCESS) 
         return nRet; 
 
      memset(&AnnHandle, 0, sizeof(ANNHANDLE)); 
      AnnHandle.uStructSize = sizeof(ANNHANDLE);   
      AnnHandle.nID         = 100; 
      AnnHandle.bVisible   = TRUE; 
      AnnHandle.crPen      = RGB(0,0,0); 
      AnnHandle.crFill     = RGB(255,0,0); 
      AnnHandle.nShape     = ANNHANDLE_SHAPE_CIRCLE; 
      AnnHandle.hCursor    = NULL; 
      AnnHandle.uFlags     = ANNHANDLE_ID | ANNHANDLE_LOCATION |  
                             ANNHANDLE_CONTAINER_COORDINATES | ANNHANDLE_VISIBLE |  
                             ANNHANDLE_PEN_COLOR | ANNHANDLE_FILL_COLOR | ANNHANDLE_SHAPE;  
 
      AnnHandle.aptContainer.x = (arc.left + arc.right)/2; 
      AnnHandle.aptContainer.y = arc.top; 
      nRet = L_AnnAddUserHandle(hRect, &AnnHandle); 
      if(nRet != SUCCESS) 
         return nRet; 
 
      AnnHandle.aptContainer.x = (arc.left + arc.right)/2; 
      AnnHandle.aptContainer.y = arc.bottom; 
      nRet = L_AnnAddUserHandle(hRect, &AnnHandle); 
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
   { 
      MessageBox(NULL, TEXT("Annotation object must be a Rectangle."), TEXT("Error"), MB_OK); 
      return 0; 
   } 
   return SUCCESS; 
} 

Help Version 20.0.2019.12.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help