docwrtpage

DOCWRTPAGE

typedef struct _DOCWRTPAGE
{
   L_UINT uStructSize;
   HENHMETAFILE hEmf;
   pBITMAPHANDLE pOverlayBitmap; //for Pdf file only
   L_DOUBLE *pdwTextScale; //For Pdf Image over text only
   HANNOBJECT hAnnObject; // handle to the root annotation
   L_VOID *pData;
} DOCWRTPAGE, *pDOCWRTPAGE;

The DOCWRTPAGE structure provides information about the page being added to the document file.

Member	Description
uStructSize	Size of this structure in bytes, for versioning. Use the sizeof() to calculate this value.
hEmf	Handle to an EMF file being added.
pOverlayBitmap	Optional pointer to the Bitmap that will be used as an overlay bitmap (image over text).
pdwTextScale	Optional pointer to double values which set the scale value ratios for each word in the EMF file to the ones in the overlay image.
hAnnObject	Handle to the root annotation object that includes all annotation objects to save in the file. This typically is a container object.
pData	Reserved for future use.

Comments

pDOCWRTPAGE is a pointer to DOCWRTPAGE structure. Generally, where a function parameter type is pDOCWRTPAGE, you can declare a DOCWRTPAGE variable; update the structure's fields, and the pass the variable's address in the parameter. Declaring a pDOCWRTPAGE variable is necessary only if your program requires a pointer.

The pOverlayBitmap parameter is an optional pointer and it should be used only when saving to PDF file formats, all other formats will not consider this pointer. The pOverlayBitmap must be the raster image of the EMF file which is set to hEmf handle.

If the PageRestriction is relaxed, hEmf is not mandatory. If hEmf is null then an empty page will be created. For PDF format, if hEmf and pOverlayBitmap contain valid data, a PDF document with raster image (the pOverlayBitmap) will be created.

The pdwTextScale parameter is an optional pointer that has no meaning if pOverlayBitmap parameter is not used. This pointer sets the scale values for each word in the EMF file to the ones in the overlay image. Providing correct scales will make selection words at resultant PDF file more accurate.

hAnnObject parameter is an options handle and it should be used only when saving to PDF file formats, currently all other formats will not consider this handle, PDF/A is not supported too.

Before using the LEADTOOLS Document Writers SDK, unlock it using the L_UnlockSupport function. If you want to use the PDF format you must also unlock PDF support with the L_UnlockSupport function.

This structure is used with the L_DocWriterAddPage function.