PdfPageCountField

6 Jul 20264 minutes to read

Represents an automatic field that displays the total number of pages in the document.

// Create a new document.
const document: PdfDocument = new PdfDocument();
// Add page to the document.
const page: PdfPage = document.addPage();
// Initialize the standard font.
const font: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 13);
// Initialize solid brush.
const brush: PdfBrush = new PdfBrush({ r: 0, g: 0, b: 0 });
// Create the page count field.
const pageCountField: PdfPageCountField = new PdfPageCountField({ font: font, brush: brush });
// Draw the page count on page.
pageCountField.draw(page.graphics, { x: 10, y: 10 });
// Save the document.
document.save('Output.pdf');
// Destroy the document.
document.destroy();

Properties

Get numberStyle PdfNumberStyle

Gets the number formatting style currently used to render the page count.

// Create a new document.
const document: PdfDocument = new PdfDocument();
// Add page to the document.
const page: PdfPage = document.addPage();
// Create the page count field.
const pageCountField: PdfPageCountField = new PdfPageCountField({numberStyle: PdfNumberStyle.lowerLatin});
// Get the number formatting style currently used to render the page count.
const style: PdfNumberStyle = pageCountField.numberStyle;
// Draw the page count on page.
pageCountField.draw(page.graphics, { x: 10, y: 10 });
// Save the document.
document.save('Output.pdf');
// Destroy the document.
document.destroy();

Set numberStyle void

Sets the number formatting style used to render the page count.

// Create a new document.
const document: PdfDocument = new PdfDocument();
// Add page to the document.
const page: PdfPage = document.addPage();
// Create the page count field.
const pageCountField: PdfPageCountField = new PdfPageCountField({numberStyle: PdfNumberStyle.lowerLatin});
// Set the number formatting style used to render the page count.
pageCountField.numberStyle = PdfNumberStyle.lowerLatin;
// Draw the page count on page.
pageCountField.draw(page.graphics, { x: 10, y: 10 });
// Save the document.
document.save('Output.pdf');
// Destroy the document.
document.destroy();

Parameter	Type	Description
value	PdfNumberStyle	The number formatting style to apply.

Methods

draw

Renders the element at the specified location on the given PdfGraphics surface.

// Create a new document.
const document: PdfDocument = new PdfDocument();
// Add a new page to document
const page: PdfPage = document.addPage();
// Create a page template with specified size.
const template: PdfPageTemplateElement = new PdfPageTemplateElement({ width: 100, height: 50 });
// Initialize a standard font.
const font: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 12);
// Create a solid brush for drawing text.
const brush: PdfBrush = new PdfBrush({ r: 0, g: 0, b: 0 });
// Create a date-time field with the configured font and brush.
const dateField: PdfGraphicsElement = new PdfDateTimeField({ font: font, brush: brush });
// Render the date field onto the template at an offset.
dateField.draw(template.graphics, { x: 20, y: 20 });
// Assign the template to the document bottom with center alignment.
document.template.bottom = {template: template, alignment: PdfTemplateHorizontalAlignment.center};
// Save the document.
document.save('output.pdf');
// Destroy the document.
document.destroy();

Parameter	Type	Description
graphics	PdfGraphics	The graphics surface to render on.
location	Point	The position for rendering.

Returns void