@syncfusion/ej2-pdf/src/pdf/core/graphics/automatic-fields/page-count-field.d.ts

Feature-rich JavaScript PDF library with built-in support for loading and manipulating PDF document.

import { PdfNumberStyle } from '../../enumerator';
import { PdfFont, PdfStringFormat } from '../../fonts';
import { PdfBrush, PdfGraphics } from '../pdf-graphics';
import { PdfSingleValueField } from './single-value-field';
/**
 * Represents an automatic field that displays the total number of pages in the document.
 *
 * ```typescript
 * // 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();
 * ```
 */
export declare class PdfPageCountField extends PdfSingleValueField {
    /**
     * Specifies the number style used for formatting the field value.
     *
     * @private
     */
    _numberStyle: PdfNumberStyle;
    /**
     * Initializes a new instance of the page count field.
     *
     * ```typescript
     * // 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();
     * // 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();
     * ```
     */
    constructor();
    /**
     * Initializes a new instance of the page count field using the specified properties.
     *
     * ```typescript
     * // 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 });
     * // Initialize a string format.
     * const format: PdfStringFormat = new PdfStringFormat(PdfTextAlignment.right);
     * // Create the page count field.
     * const pageCountField: PdfPageCountField = new PdfPageCountField({ font: font, brush: brush, stringFormat: format, 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();
     * ```
     *
     * @param {Object} properties - Configuration object used to define rendering behavior.
     * @param {PdfFont} [properties.font] - The font used to render the field text.
     * @param {PdfBrush} [properties.brush] - The brush used to define the text color.
     * @param {PdfStringFormat} [properties.stringFormat] - The format used for text layout and alignment.
     * @param {PdfNumberStyle} [properties.numberStyle] - The number style used to format the page count.
     */
    constructor(properties: {
        font?: PdfFont;
        brush?: PdfBrush;
        stringFormat?: PdfStringFormat;
        numberStyle?: PdfNumberStyle;
    });
    /**
     * Gets the number formatting style currently used to render the page count.
     *
     * ```typescript
     * // 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();
     * ```
     *
     * @returns {PdfNumberStyle} The current number formatting style.
     */
    /**
    * Sets the number formatting style used to render the page count.
    *
    * ```typescript
    * // 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();
    * ```
    *
    * @param {PdfNumberStyle} value The number formatting style to apply.
    */
    numberStyle: PdfNumberStyle;
    /**
     * Resolves total page count.
     *
     * @private
     * @param {PdfGraphics} graphics The graphics context.
     * @returns {string} The formatted page count.
     */
    _getValue(graphics: PdfGraphics): string;
}