LAnnRTF::ChangeUserHandle

#include "ltwrappr.h"

virtual L_INT LAnnRTF::ChangeUserHandle(nIndex, pAnnHandle)

L_INT32 nIndex;	/* index of the user handle to change */
pANNHANDLE pAnnHandle;	/* pointer to a structure that defines how to change the user handle */

Changes properties of an existing user-defined annotation handle. This function is available in the Document/Medical Toolkits.

Parameter	Description
nIndex	Index of the user handle to change. This index is zero-based.
pAnnHandle	Pointer to a structure that defines how to change the user handle.

Returns

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

Comments

Use this function to change the properties of an existing user-defined annotation handle.

This function is used in conjunction with the LAnnRTF::AddUserHandle and LAnnRTF::EnumerateHandles functions.

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.

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

Example

// This example changes the first user handle of an object by
// * Moving handle ten pixels to the left
// * Changing color of handle to blue
// * Changing shape of handle to square
// * Displays the hour glass cursor when mouse over the handle
L_VOID ExampleAnnChangeUserHandle(LAnnRTF *LRtf)
{
   L_UINT uCount;
   ANNHANDLE AnnHandle;

   // Get the total count of user handles
   LRtf->GetUserHandles(NULL, &uCount);
   if (uCount > 0)
   {
      memset(&AnnHandle, 0, sizeof(ANNHANDLE));
      AnnHandle.uStructSize = sizeof(&AnnHandle);
      LRtf->GetUserHandle(0, &AnnHandle);

      AnnHandle.aptContainer.x +=10;
      AnnHandle.crFill = RGB(0,0,255);
      AnnHandle.nShape = ANNHANDLE_SHAPE_SQUARE;
      AnnHandle.hCursor = LoadCursor(NULL,IDC_APPSTARTING);
      AnnHandle.uFlags = ANNHANDLE_FILL_COLOR | ANNHANDLE_SHAPE | ANNHANDLE_LOCATION | ANNHANDLE_CONTAINER_COORDINATES;
      LRtf->ChangeUserHandle(0, &AnnHandle);
   }
   else
      MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
}