LAnnTextPointer::ChangeUserHandle (original) (raw)
Summary
Changes properties of an existing user-defined annotation handle.
Syntax
#include "ltwrappr.h"
virtual L_INT LAnnTextPointer::ChangeUserHandle(nIndex, pAnnHandle)
Parameters
L_INT32 nIndex
Index of the user handle to change. This index is zero-based.
pANNHANDLE pAnnHandle
Pointer to a structure that defines how to change the user handle.
Returns
Value | Meaning |
---|---|
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:
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
- LAnnTextPointer::AddUserHandle
- LAnnTextPointer::EnumerateHandles
- LAnnTextPointer::EnumHandleCallBack
- LAnnTextPointer::GetUserHandle
- LAnnTextPointer::GetUserHandles
- LAnnTextPointer::DeleteUserHandle
- 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
- Fixed Annotations
- Minimizing Flicker With Double Buffering
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_INT LAnnTextPointer_ChangeUserHandleExample(LAnnTextPointer *LTextPointer)
{
L_INT nRet;
L_UINT uCount;
ANNHANDLE AnnHandle;
// Get the total count of user handles
LTextPointer->GetUserHandles(NULL, &uCount);
if (uCount > 0)
{
memset(&AnnHandle, 0, sizeof(ANNHANDLE));
AnnHandle.uStructSize = sizeof(&AnnHandle);
nRet = LTextPointer->GetUserHandle(0, &AnnHandle);
if(nRet != SUCCESS)
return nRet;
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;
nRet = LTextPointer->ChangeUserHandle(0, &AnnHandle);
if(nRet != SUCCESS)
return nRet;
}
else
{
MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
return FAILURE;
}
return SUCCESS;
}
LEADTOOLS Raster Imaging C++ Class Library Help