#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnCopyToClipboard(hObject, uFormat, fSelected, fEmpty, fCheckMenu)
Copies the specified annotation objects to the Windows clipboard in either the native format or WMF format.
Handle to the annotation object.
Format for the annotation data. Possible values are:
Value | Meaning |
---|---|
ANNFMT_EMF | Use the Windows EMF format. |
ANNFMT_WMF | Use the Windows WMF format. |
ANNFMT_XML | Use the XML text format. This is LEADs new text-based format which is upward-compatible. |
Flag that indicates whether to copy all selected objects, or just the specified object. Possible values are:
Value | Meaning |
---|---|
TRUE | Copy all objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions. |
FALSE | Copy only the specified object. |
Flag that indicates whether to empty the clipboard prior to copying the annotation data to it. Possible values are:
Value | Meaning |
---|---|
TRUE | Empty the clipboard before copying data to it. |
FALSE | Add to the existing data on the clipboard. |
Flag that indicates whether check the automation menu to see if ANNAUTOTEXT_MENU_COPY has been checked. Possible values are:
Value | Meaning |
---|---|
TRUE | Check the automation menu to see if ANNAUTOTEXT_MENU_COPY has been checked for the specified object. Only those objects with ANNAUTOTEXT_MENU_COPY checked will be copied. |
FALSE | Do not check the automation menu to see if ANNAUTOTEXT_MENU_COPY has been checked for the specified object. The copied objects are determined by fSelected only. |
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
(Document and Medical) Use the WMF format only for copying for use in another application.
To retain scaling and positioning information, this function always copies the root container, along with the specified object or selected objects. Use the hObject
and fSelected
parameters as follows:
To copy the specified object, set hObject to that object and set fSelected to FALSE.
To copy only selected objects in a container, set hObject to the container and set fSelected to TRUE.
To copy all objects in a container, set hObject to the container and set fSelected to FALSE.
Required DLLs and Libraries
Win32, x64.
This example copies all annotations to the clipboard.
L_INT AnnCopyToClipboardExample(HANNOBJECT hAnnObject)
{
HANNOBJECT TopContainer; /* Root container */
L_INT nRet;
/* Get the root container */
L_AnnGetTopContainer(hAnnObject, &TopContainer);
/* Copy all annotations to the clipboard */
nRet = L_AnnCopyToClipboard(TopContainer, ANNFMT_XML, FALSE, TRUE, FALSE);
if (nRet == SUCCESS)
MessageBox(NULL, TEXT("Annotations copied."), TEXT("Notice"), MB_OK);
else
return nRet;
return SUCCESS;
}
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document