Print Page

Printing a webpage is a common task, whether for sharing information or maintaining archives. Selenium simplifies this process through its PrintOptions, PrintsPage, and browsingContext classes, which provide a flexible and intuitive interface for automating the printing of web pages. These classes enable you to configure printing preferences, such as page layout, margins, and scaling, ensuring that the output meets your specific requirements.

Configuring

Orientation

Using the getOrientation() and setOrientation() methods, you can get/set the page orientation — either PORTRAIT or LANDSCAPE.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Range

Using the getPageRanges() and setPageRanges() methods, you can get/set the range of pages to print — e.g. “2-4”.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Size

Using the getPaperSize() and setPaperSize() methods, you can get/set the paper size to print — e.g. “A0”, “A6”, “Legal”, “Tabloid”, etc.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Margins

Using the getPageMargin() and setPageMargin() methods, you can set the margin sizes of the page you wish to print — i.e. top, bottom, left, and right margins.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Scale

Using getScale() and setScale() methods, you can get/set the scale of the page you wish to print — e.g. 1.0 is 100% or default, 0.25 is 25%, etc.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Background

Using getBackground() and setBackground() methods, you can get/set whether background colors and images appear — boolean true or false.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

ShrinkToFit

Using getBackground() and setBackground() methods, you can get/set whether the page will shrink-to-fit content on the page — boolean true or false.

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin

Printing

Once you’ve configured your PrintOptions, you’re ready to print the page. To do this, you can invoke the print function, which generates a PDF representation of the web page. The resulting PDF can be saved to your local storage for further use or distribution. Using PrintsPage(), the print command will return the PDF data in base64-encoded format, which can be decoded and written to a file in your desired location, and using BrowsingContext() will return a String.

There may currently be multiple implementations depending on your language of choice. For example, with Java you have the ability to print using either BrowingContext() or PrintsPage(). Both take PrintOptions() objects as a parameter.

Note: BrowsingContext() is part of Selenium’s BiDi implementation. To enable BiDi see Enabling Bidi

• Java
• CSharp
• Ruby
• Python
• JavaScript
• Kotlin