In This Topic ▼

LImageViewerCell::GetAnnotationContainer

Summary

Gets the annotation container for the specific frame.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::GetAnnotationContainer(nSubCellIndex, PhAnnContainer, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This sub-cell contains the image that contains the annotation container. Pass -2 to refer to the selected sub-cell.

HANNOBJECT * PhAnnContainer

Address of the variable to be updated with the handle to the annotation container that is found at the specified sub-cell.

L_UINT uFlags

If uFlags contains CELL_ANNOTATION_INCLUDE_TEXT, the image viewer will replace the annotation text with default text. The default text has a fixed size regardless of the scaling of the image inside the medical viewer.

Returns

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

Comments

This function gets a copy of the annotation container. You must free it once it is no longer needed.

This function gets the annotation container. To set the annotation container use the LImageViewerCell::SetAnnotationContainer function.

Required DLLs and Libraries

LTIVW
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Example

This example will copy the annotation container from the specified sub-cell clicked by the user using the left mouse button, and paste the annotation container on the specified sub-cell clicked by the user using the right mouse button.

class LImageViewerChild4:public LImageViewerCell 
{ 
   virtual L_INT MouseCallBack(L_UINT                 uMessage, 
                               pDISPCONTAINERCELLINFO pCellInfo); 
}; 
 
HANNOBJECT hContainer; 
L_INT LImageViewerChild4::MouseCallBack(L_UINT                 uMessage, 
                                 pDISPCONTAINERCELLINFO pCellInfo) 
{ 
   UNREFERENCED_PARAMETER(pCellInfo); 
 
   switch(uMessage) 
   { 
   case WM_LBUTTONUP: 
         GetAnnotationContainer(pCellInfo->nSubCellIndex, &hContainer, 0); 
      break; 
 
   case WM_RBUTTONUP: 
         SetAnnotationContainer(pCellInfo->nSubCellIndex, hContainer, 0); 
      break; 
   } 
 
   return SUCCESS; 
} 
 
L_INT LImageViewer_GetAnnotationContainerExample(LImageViewerCell& ImageViewerCell) 
{ 
   ImageViewerCell.EnableMouseCallBack( TRUE); 
 
   return SUCCESS; 
}