PdfPageNumberField class Null safety

Represents PDF document page number field. Represents an automatic field to display page number within a section.

//Create a new pdf document
PdfDocument document = PdfDocument();
//Add the pages to the document
for (int i = 1; i <= 5; i++) {
  document.pages.add().graphics.drawString(
      'page$i', PdfStandardFont(PdfFontFamily.timesRoman, 11),
      bounds: Rect.fromLTWH(250, 0, 615, 100));
}
//Create the footer with specific bounds
PdfPageTemplateElement footer = PdfPageTemplateElement(
    Rect.fromLTWH(0, 0, document.pages[0].getClientSize().width, 50));
//Create the page number field
PdfPageNumberField pageNumber = PdfPageNumberField(
    font: PdfStandardFont(PdfFontFamily.timesRoman, 19),
    brush: PdfSolidBrush(PdfColor(0, 0, 0)));
//Sets the number style for page number
pageNumber.numberStyle = PdfNumberStyle.upperRoman;
//Create the composite field with page number page count
PdfCompositeField compositeField = PdfCompositeField(
    font: PdfStandardFont(PdfFontFamily.timesRoman, 19),
    brush: PdfSolidBrush(PdfColor(0, 0, 0)),
    text: 'Page No: {0}',
    fields: <PdfAutomaticField>[pageNumber]);
compositeField.bounds = footer.bounds;
//Add the composite field in footer
compositeField.draw(
    footer.graphics,
    Offset(
        290, 50 - PdfStandardFont(PdfFontFamily.timesRoman, 19).height));
//Add the footer at the bottom of the document
document.template.bottom = footer;
//Save the document.
List<int> bytes = document.save();
//Dispose the document.
document.dispose();
Inheritance
Implementers

Constructors

PdfPageNumberField({PdfFont? font, PdfBrush? brush, Rect? bounds, bool? isSectionPageNumber})
Initializes a new instance of the PdfPageNumberField class and may also with the classes are PdfFont, PdfBrush and Rect. [...]

Properties

bounds Rect
Gets or sets the bounds of the field. [...]
read / write, inherited
brush PdfBrush
Gets or sets the brush of the field. [...]
read / write, inherited
font PdfFont
Gets or sets the font of the field. [...]
read / write, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
numberStyle PdfNumberStyle
Gets or sets the specific number style. [...]
read / write
pen PdfPen?
Gets or sets the pen of the field. [...]
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
stringFormat PdfStringFormat?
Gets or sets the stringFormat of the field. [...]
read / write, inherited

Methods

draw(PdfGraphics graphics, [Offset? location]) → void
Draws an element on the Graphics. Graphics context where the element should be printed. location has contains X co-ordinate of the element, Y co-ordinate of the element. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited