Class ChromePdfRenderOptions

Html To PDF output options for ChromePdfRenderer. Specifies options such as Paper-Size, DPI, Headers and Footers and other Chromium specific browser setup options.

Inheritance

System.Object

ChromePdfRenderOptions

Implements

IMargins

Namespace: IronPdf

Assembly: IronPdf.dll

Syntax

public class ChromePdfRenderOptions : Object, IHeaderFooter, IMargins

Constructors

ChromePdfRenderOptions()

Default Constructor. Creates a new instance of ChromePdfRenderOptions with default settings.

Declaration

public ChromePdfRenderOptions()

Fields

CustomCookies

Custom cookies for this HTML render. Cookies do not persist in between renders and must be set each time.

Declaration

public Dictionary<string, string> CustomCookies

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

HttpRequestHeaders

Custom HTTP request headers to be sent with the HTML

Declaration

public Dictionary<string, string> HttpRequestHeaders

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

PaperFit

A html-to-virtual paper setup manager allowing the developer to control how content will be laid out on PDF "paper" pages.

Include options for: Deafult Chrome Behavior, Zoomed, Responsive CSS3 Layouts, SCale-To-Page & Continuous Feed (e.g. reciept) style PDF page setups.

Declaration

public readonly VirtualPaperLayoutManager PaperFit

Field Value

Type	Description
VirtualPaperLayoutManager

Properties

CreatePdfFormsFromHtml

Turns all Html forms elements into editable PDF forms.

Default value is true.

Declaration

public bool CreatePdfFormsFromHtml { get; set; }

Property Value

Type	Description
System.Boolean

CssMediaType

Enables Media="screen" CSS Styles and StyleSheets

Note: By setting AllowScreenCss=false, IronPdf renders PDFs from HTML using CSS for media="print" as if printing a web page in a browser print dialog.

Default value is PdfCssMediaType.Screen.

Declaration

public PdfCssMediaType CssMediaType { get; set; }

Property Value

Type	Description
PdfCssMediaType

CustomCssUrl

Allows a custom CSS style-sheet to be applied to Html before rendering. May be a local file path or a remote url.

Declaration

public string CustomCssUrl { get; set; }

Property Value

Type	Description
System.String

Remarks

Only applicable when rendering Html to Pdf

DefaultChrome

A ChromePdfRenderOptions preset with default settings that match the vanilla PDF viewer in Chrome.

These values are:
CssMediaType: Print, FirstPageNumber: 1, IronPdf.ChromePdfRenderOptions.FitToPaperMode: IronPdf.Engines.Chrome.FitToPaperModes.None, Top and left margin: 0.39 in, Bottom and Right margin: 0.38 in, PaperSize: A4, PaperOrientation: Portrait, PrintHtmlBackgrounds: false, IronPdf.ChromePdfRenderOptions.RenderDelay: 20

Declaration

public static ChromePdfRenderOptions DefaultChrome { get; }

Property Value

Type	Description
ChromePdfRenderOptions

EnableJavaScript

Enables JavaScript and Json to be executed before the page is rendered. Ideal for printing from Ajax / Angular Applications.

Also see IronPdf.ChromePdfRenderOptions.RenderDelay

Default value is false.

Declaration

public bool EnableJavaScript { get; set; }

Property Value

Type	Description
System.Boolean

EnableMathematicalLaTex

Enables Mathematical LaTeX Elements Rendering

Declaration

public bool EnableMathematicalLaTex { get; set; }

Property Value

Type	Description
System.Boolean

FirstPageNumber

First page number to be used in PDF Headers and Footers.

Default value is 1.

Declaration

public int FirstPageNumber { get; set; }

Property Value

Type	Description
System.Int32

ForcePaperSize

Force page sizes to be exactly what is specified via PaperSize by resizing the page after generating a PDF from HTML

Useful for bypassing CSS rules which specify paper size

Declaration

public bool ForcePaperSize { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Helps correct small errors in page size when rendering HTML to PDF

GrayScale

Outputs a black-and-white PDF

Default value is false.

Declaration

public bool GrayScale { get; set; }

Property Value

Type	Description
System.Boolean

HtmlFooter

Sets the footer content for every PDF page as Html. Supports 'mail-merge'.

Declaration

public HtmlHeaderFooter HtmlFooter { get; set; }

Property Value

Type	Description
HtmlHeaderFooter

HtmlHeader

Sets the header content for every PDF page as Html. Supports 'mail-merge'.

Declaration

public HtmlHeaderFooter HtmlHeader { get; set; }

Property Value

Type	Description
HtmlHeaderFooter

InputEncoding

The input character encoding as a string;

Default value is Encoding.UTF8.

Declaration

public Encoding InputEncoding { get; set; }

Property Value

Type	Description
System.Text.Encoding

Javascript

A custom javascript string to be executed after all HTML has loaded but before PDf rendering.

Declaration

public string Javascript { get; set; }

Property Value

Type	Description
System.String

JavascriptMessageListener

Method callback to be invoked whenever a browser JavaScript console message becomes available.

Declaration

public StringDelegate JavascriptMessageListener { get; set; }

Property Value

Type	Description
StringDelegate

MarginBottom

Bottom PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.

Default value is 25. However, this value will be ignored unless UseMarginsOnHeaderAndFooter is set to Bottom, TopAndBottom, or All.

Declaration

public double MarginBottom { get; set; }

Property Value

Type	Description
System.Double

MarginLeft

Left PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.

Default value is 25. This value is enabled by default, as UseMarginsOnHeaderAndFooter defaults to LeftAndRight. To explicitly disable, set UseMarginsOnHeaderAndFooter to a value that excludes Left.

Declaration

public double MarginLeft { get; set; }

Property Value

Type	Description
System.Double

MarginRight

Right PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.

Default value is 25. This value is enabled by default, as UseMarginsOnHeaderAndFooter defaults to LeftAndRight. To explicitly disable, set UseMarginsOnHeaderAndFooter to a value that excludes Right.

Declaration

public double MarginRight { get; set; }

Property Value

Type	Description
System.Double

MarginTop

Top PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.

Default value is 25. However, this value will be ignored unless UseMarginsOnHeaderAndFooter is set to Top, TopAndBottom, or All.

Declaration

public double MarginTop { get; set; }

Property Value

Type	Description
System.Double

PaperOrientation

The PDF paper orientation. E.g. Portrait or Landscape.

Default value is Portrait.

Declaration

public PdfPaperOrientation PaperOrientation { get; set; }

Property Value

Type	Description
PdfPaperOrientation

PaperSize

Set an output paper size for PDF pages. System.Drawing.Printing.PaperKind.

Use SetCustomPaperSize(int width, int height) for custom sizes.

Default value is A4.

Declaration

public PdfPaperSize PaperSize { get; set; }

Property Value

Type	Description
PdfPaperSize

PrintHtmlBackgrounds

Prints background-colors and images from Html.

Default value is true.

Declaration

public bool PrintHtmlBackgrounds { get; set; }

Property Value

Type	Description
System.Boolean

RequestContext

Request context for this render. Determines isolation of certain resources such as cookies.

See RequestContexts for more information

Declaration

public RequestContexts RequestContext { get; set; }

Property Value

Type	Description
RequestContexts

Type	Description
TableOfContentsTypes

TextFooter

Sets the footer content for every PDF page as text. Supports 'mail-merge' and automatically turns urls into hyperlinks..

Declaration

public ITextHeaderFooter TextFooter { get; set; }

Property Value

Type	Description
IronPdf.ITextHeaderFooter

TextHeader

Sets the header content for every PDF page as text. Supports 'mail-merge' and automatically turns urls into hyperlinks..

Declaration

public ITextHeaderFooter TextHeader { get; set; }

Property Value

Type	Description
IronPdf.ITextHeaderFooter

Timeout

Render timeout in seconds

Default value is 60.

Declaration

public int Timeout { get; set; }

Property Value

Type	Description
System.Int32

Title

PDF Document Name and Title meta-data. Not required. Useful for mail-merge and automatic file naming in the IronPdf MVC and Razor extensions.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

UseMarginsOnHeaderAndFooter

Use margin values from the main document when rendering headers and footers.

This value is ignored when header and footer heights are autosized. Autosizing occurs when a header or footer MaxHeight value is null.

The default value is LeftAndRight. To apply margins on all edges, use All.

Declaration

public UseMargins UseMarginsOnHeaderAndFooter { get; set; }

Property Value

Type	Description
UseMargins

WaitFor

A wrapper object that holds configuration for wait-for mechanism for user to wait for certain events before rendering.

Declaration

public WaitFor WaitFor { get; set; }

Property Value

Type	Description
WaitFor

Remarks

By default, it will wait for nothing.

Methods

Clone()

Supports System.ICloneable. Creates a deep copy of this class instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A deep clone of this instance. Use explicit casting to convert object back to the intended type.

SetCustomPaperSizeinCentimeters(Double, Double)

Set an output paper size for PDF pages. Dimensions are in Centimeters.

Declaration

public void SetCustomPaperSizeinCentimeters(double width, double height)

Parameters

Type	Name	Description
System.Double	width	Custom paper width in cm.
System.Double	height	Custom paper height in cm.

SetCustomPaperSizeInInches(Double, Double)

Set an output paper size for PDF pages. Dimensions are in Inches.

Declaration

public void SetCustomPaperSizeInInches(double width, double height)

Parameters

Type	Name	Description
System.Double	width	Custom paper width in Inches.
System.Double	height	Custom paper height in Inches.

SetCustomPaperSizeinMilimeters(Double, Double)

Set an output paper size for PDF pages. Dimensions are in millimeters.

Declaration

public void SetCustomPaperSizeinMilimeters(double width, double height)

Parameters

Type	Name	Description
System.Double	width	Custom paper width in millimeters.
System.Double	height	Custom paper height in millimeters.

SetCustomPaperSizeinPixelsOrPoints(Double, Double, Int32)

Set an output paper size for PDF pages. Dimensions are in screen Pixels or printer Points.

Declaration

public void SetCustomPaperSizeinPixelsOrPoints(double width, double height, int DPI = 96)

Parameters

Type	Name	Description
System.Double	width	Custom paper width in pixels/points.
System.Double	height	Custom paper height in pixels/points.
System.Int32	DPI	Intended print resolution of the PDF. To be clear PDFs have no fixed DPI/PPI value for rendering. 72 and 96 are common onscreen values. 300 is a comon value used in commercial printing.

Implements

IMargins