PAGENUMBEROPTIONS

typedef struct _PAGENUMBEROPTIONS 
{ 
   L_UINT uStructSize; 
   L_INT nPadding[2]; 
   L_TCHAR *pszPageFormat; 
   L_HFONT hFont; 
   COLORREF crFontColor; 
   L_UINT uStartPageNumber; 
   L_UINT uPageCount; 
   PAGENUMBERLOCATION nLocation; 
} PAGENUMBEROPTIONS, *pPAGENUMBEROPTIONS; 

The PAGENUMBEROPTIONS structure contains page number fonts and formatting information.

Member

Description

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

nPadding[2]

Array that contains the distance btween the page numbers and the edge of the page, in pixels (X, Y). Defaults to (0, 0).

pszPageFormat

Character string contains speical page formats. Use the following formats:

  • "Page ###PAGE_NUMBER###"
  • "Page ###PAGE_NUMBER### of ###PAGE_COUNT###"

For example, to create "Page 5" pass "Page ###PAGE_NUMBER###", or to create "Page 1 of 4" pass "Page ###PAGE_NUMBER### of ###PAGE_COUNT###".

hFont

Font to be used.

crFontColor

Color value that indicates the color of the page number. This must be set.

uStartPageNumber Start page number, pass 0 means page number 1, the default is 1.
uPageCount Page count in bitmap list, pass 0 means total page count in bitmap list.
nLocation Enumeration value that specifies the location of the page numbers. Defaults to PAGENUMBERLOCATION_TOPLEFT. For possible values, see PAGENUMBERLOCATION.

Comments

pPAGENUMBEROPTIONS is a pointer to a PAGENUMBEROPTIONS structure. Where the function parameter type is pPAGENUMBEROPTIONS, you can declare a PAGENUMBEROPTIONS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pPAGENUMBEROPTIONS variable is necessary only if your program requires a pointer.

This structure is used by the L_AddPageNumbersToBitmapList function.

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help