PdfPrintSettings (com.equo.chromium 124.0.0-SNAPSHOT API)
Skip navigation links
com.equo.chromium.utils

Class PdfPrintSettings


  • public class PdfPrintSettings
extends Object
    PDF print settings for browser.printToPDF()

    • Field Detail

      • landscape

        public boolean landscape
        Set to true for landscape mode or false for portrait mode.

      • print_background

        public boolean print_background
        Set to true to print background graphics or false to not print background graphics.

      • scale

        public double scale
        The percentage to scale the PDF by before printing (e.g. .5 is 50%). If this value is less than or equal to zero the default value of 1.0 will be used.

      • paper_width

        public double paper_width
        Output paper size in inches. If either of these values is less than or equal to zero then the default paper size (letter, 8.5 x 11 inches) will be used.

      • paper_height

        public double paper_height
        Output paper size in inches. If either of these values is less than or equal to zero then the default paper size (letter, 8.5 x 11 inches) will be used.

      • prefer_css_page_size

        public boolean prefer_css_page_size
        Set to true to prefer page size as defined by css. Defaults to false in which case the content will be scaled to fit the paper size.

      • margin_top

        public double margin_top
        Margins in inches. Only used if margin_type is set to CUSTOM. Specifies the top margin.

      • margin_right

        public double margin_right
        Margins in inches. Only used if margin_type is set to CUSTOM. Specifies the right margin.

      • margin_bottom

        public double margin_bottom
        Margins in inches. Only used if margin_type is set to CUSTOM. Specifies the bottom margin.

      • margin_left

        public double margin_left
        Margins in inches. Only used if margin_type is set to CUSTOM. Specifies the left margin.

      • page_ranges

        public String page_ranges
        Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.

      • display_header_footer

        public boolean display_header_footer
        Set to true to print headers and footers or false to not print headers and footers. Modify header_template and/or footer_template to customize the display.

      • header_template

        public String header_template
        HTML template for the print header. Only displayed if |display_header_footer| is true (1). Should be valid HTML markup with the following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document For example, "" would generate a span containing the title.

      • footer_template

        public String footer_template
        HTML template for the print footer. Only displayed if |display_header_footer| is true (1). Uses the same format as |header_template|.

    • Constructor Detail

      • PdfPrintSettings

        public PdfPrintSettings()
Skip navigation links

Copyright © 2024. All rights reserved.