PdfDynamicField

6 Jul 20262 minutes to read

Represents an abstract class for all dynamic fields.

// Create a new document.
const document: PdfDocument = new PdfDocument();
// Create the first section within the document.
const section: PdfSection = document.addSection();
// Add a page to section1.
let page: PdfPage = section.addPage();
// Initialize the standard font.
const font: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 13);
// Initialize the solid brush.
const brush: PdfBrush = new PdfBrush({ r: 255, g: 0, b: 255 });
// Create a dynamic field with font and brush.
const sectionNumField: PdfDynamicField = new PdfSectionNumberField({ font: font, brush: brush });
// Draw the section number field field onto the page graphics.
sectionNumField.draw(page.graphics, { x: 150, y: 10 });
// Save the document.
document.save('output.pdf');
// Destroy the document.
document.destroy();

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