LAnnotation::CopyToClipboard

#include "ltwrappr.h"

virtual L_INT LAnnotation::CopyToClipboard(uFormat=ANNFMT_XML, bSelected=FALSE, bEmpty=FALSE, fCheckMenu=FALSE)

L_UINT uFormat;	/* format for the annotation data */
L_BOOL bSelected;	/* flag that indicates whether to copy all selected objects, or just the specified object */
L_BOOL bEmpty;	/* flag that indicates whether to empty the clipboard prior to copying the annotation data to it.*/
L_BOOL fCheckMenu;	/* flag that indicates whether to check the automation menu */

Copies the annotation object to the Windows clipboard in either the native format or WMF format.

Parameter	Description
uFormat	Format for the annotation data. Possible values are:
	Value	Meaning
	ANNFMT_WMF	Use the Windows WMF format.
	ANNFMT_XML	Use the XML format. This is the default value.
bSelected	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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected functions.
	FALSE	Copy only the specified object.
bEmpty	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.
fCheckMenu	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.

Returns

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

Comments

Use the WMF format only for copying for use in another application.

If the annotation object is a container, then to retain scaling and positioning information, this function will always copy the root container, along with the specified object or selected objects. Use the bSelected parameter as follows:

To copy only selected objects in a container, set bSelected to TRUE.

To copy all objects in a container, set bSelected to FALSE.

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:	Class Members
Topics:	Annotation Functions: Creating and Deleting Annotations
	Implementing Annotations

Example

L_INT LAnnotation_CopyToClipboardExample(LAnnotation& LeadAnn,HWND hWnd)
{  
   L_INT nRet;
   if (LeadAnn.IsClipboardReady() == TRUE)
   {    
      LAnnContainer  LeadAContainer ;
      ANNPOINT       AnnPoint ;
      nRet = LeadAnn.GetTopContainer(&LeadAContainer) ;
      if(nRet != SUCCESS)
         return nRet;
      nRet = LeadAnn.CopyToClipboard() ;
      if(nRet != SUCCESS)
         return nRet;
      nRet = LeadAnn.Destroy() ;
      if(nRet != SUCCESS)
         return nRet;
      //...
      AnnPoint.x = 30 ;
      AnnPoint.y = 30 ;
      nRet = LeadAContainer.CopyFromClipboard(hWnd) ;
      if(nRet != SUCCESS)
         return nRet;
      nRet = LeadAContainer.Flip(&AnnPoint) ;
      if(nRet != SUCCESS)
         return nRet;
   }
   else
      return FAILURE;
   return SUCCESS;
}