PageNumber Class Properties

In this section, the PageNumber class properties are presented in alphabetical order.

Description

Use the BackgroundFile property to specify a file to be used for the page number, as a string.

You must specify an absolute file name.

This property is read/write.

Considerations Using the BackgroundFile Property

You should either use the BackgroundFile property, or you should use the other properties associated with this class, like position or font. You cannot use both.

The file you specify must be a PDF file. The page size of the background PDF must be the same as the target PDF document, otherwise the page numbering doesn't work properly. All page numbering starts on the first page of the target document.

Description

Use the FontName property to specify the name of the font to be used for the page number, as a string. Valid values are:

  • Courier

  • Courier-Bold

  • Courier-BoldOblique

  • Helvetica (this is the default value)

  • Helvetica-Bold

  • Helvetica-BoldOblique

  • Helvetica-Oblique

  • Symbol

  • Times-Bold

  • Time-BoldItalic

  • Time-Italic

  • Time-Roman

  • ZapfDingbats

If you specify an invalid font name, the default (Helvetica) is used.

This property is read/write.

Description

Use the FontSize property to specify the size of the page number, as a number.

The default value is 8.

This property is read/write.

Description

Use the PositionX property to specify the X axis position of the text page number in the merged document.

This property is read/write.

Description

Use the PositionY property to specify the Yaxis position of the text page number in the merged document.

This property is read/write.

Description

Use the StartFromPageNum property to specify the page index from which you'd like to start the page numbering.

For example, if you have a PDF document which has two cover pages, and you want to start printing page numbers on the document from the third page, specify a three for this property.

This property is read/write.

Description

Use the StartNum property to specify the page number to use as the first page number in the merged document. If you don't specify a starting number, the pages are numbered starting from 1.

This property is read/write.