DOCWRTEMFPAGE

Summary

The DOCWRTEMFPAGE structure provides information about one Windows Enhanced Metafile (WMF) page to be added to a document file.

Syntax

typedef struct _DOCWRTEMFPAGE 
{ 
   DOCWRTPAGE Page; 
   HENHMETAFILE hEmf; 
   pBITMAPHANDLE pOverlayBitmap; 
   L_DOUBLE * pdwTextScale; 
   HANNOBJECT hAnnObject; 
   L_VOID * pData; 
} DOCWRTEMFPAGE, * pDOCWRTEMFPAGE; 

Members

Page

Page structure containing common information about the page to be added.

hEmf

The Windows Enhanced Meta File handle representation of the page.

pOverlayBitmap

Pointer to the Bitmap that will be used as an overlay bitmap over the page.

pdwTextScale

Internally used by LEADTOOLS.

hAnnObject

LEADTOOLS Annotation container that contains the objects to use when annotating a page in PDF documents.

pData

Internally used by LEADTOOLS.

Comments

The DOCWRTEMFPAGE structure contains the data for one EMF page to be added to a document file. It is used as a parameter to the L_DocWriterAddPage or L_DocWriterInsertPage functions used to add the page.

The hEmf member must contain a valid Windows Enhanced Meta File handle (EMF) that contains the visual representation of the page.

hEmf is used as is when L_DocWriterAddPage or L_DocWriterInsertPage is called and the framework does not delete it. You must use the Windows API DeleteEnhMetaFile to delete the object when it is no longer used.

The pOverlayBitmap member is optional and is used only when the document being created is PDF with the Image/Text overlay option.

The Dots/Inch (DPI) of the page is the same as the DPI stored in the hEmf member. Therefore, to create a page with 300 DPI, you must add a document page with an EMF that has a DPI of 300 (both horizontally or vertically although the LEADTOOLS Document Writer supports different values for the DPI). If you are using the PDF with image/text feature, you must set the DPI of pOverlayBitmap to the same DPI as the EMF handle.

The LEADTOOLS Document Writer supports creating documents with zero or more empty pages inside them. Use L_DocWriterAddPage or L_DocWriterInsertPage to add an DOCWRTEMPTYPAGE object with the dimension of the empty page set before-hand in dEmptyPageWidth and dEmptyPageHeight and its resolution set to dEmptyPageResolution in the DOCWRTOPTIONS object. As many empty pages as desired can be added in any index desired. To use empty pages, make sure the PageRestriction member is set to DOCWRTPAGERESTRICTION_RELAXED.

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.