Class BasePdfRenderOptions

Pdf render options common to all render implementations

Inheritance
System.Object
BasePdfRenderOptions
ChromePdfRenderOptions
WebKitPdfRenderOptions
Namespace: IronPdf.Rendering.Abstractions
Assembly: IronPdf.dll
Syntax
public abstract class BasePdfRenderOptions : Object, IPdfRenderOptions, IPaperSize, IMargins, IZoomable, IViewPort, IUnitTestable, IHeadersAndFooters, ICustomCss, IJavascript, ICssMediaType

Constructors

BasePdfRenderOptions()

Declaration
protected BasePdfRenderOptions()

Properties

ApplyMarginToHeaderAndFooter

Apply margin option to Html Headers and Footers. default is false which make Html Headers and Footers have 0 margin. Only support ChromeRender

Declaration
public bool ApplyMarginToHeaderAndFooter { get; set; }
Property Value
Type Description
System.Boolean

CreatePdfFormsFromHtml

Turns all Html forms elements into editable PDF forms.

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.

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 remote url.

Declaration
public string CustomCssUrl { get; set; }
Property Value
Type Description
System.String

EnableJavaScript

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

Also see RenderDelay

Declaration
public bool EnableJavaScript { get; set; }
Property Value
Type Description
System.Boolean

FirstPageNumber

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

Declaration
public int FirstPageNumber { get; set; }
Property Value
Type Description
System.Int32
See Also

GenerateUniqueDocumentIdentifiers

Set to false if you wish to use binary file equality to compare PDFs such as for Unit Tests.

if false, System.Guid is not generated inside PDF DOM (better for unit testing) and BinaryData of two identical PDF files is the same.

If true, System.Guid is generated inside PDF DOM (better for security) and BinaryData of two identical PDF files differs.

Default value is false.

Declaration
public bool GenerateUniqueDocumentIdentifiers { get; set; }
Property Value
Type Description
System.Boolean

HtmlFooter

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

Declaration
public HtmlHeaderFooter HtmlFooter { get; set; }
Property Value
Type Description
HtmlHeaderFooter

HtmlHeader

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

Declaration
public HtmlHeaderFooter HtmlHeader { get; set; }
Property Value
Type Description
HtmlHeaderFooter

MarginBottom

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

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.

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.

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.

Declaration
public double MarginTop { get; set; }
Property Value
Type Description
System.Double

PaperOrientation

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

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.

Declaration
public PdfPaperSize PaperSize { get; set; }
Property Value
Type Description
PdfPaperSize

PrintHtmlBackgrounds

Prints background-colors and images from Html.

Declaration
public bool PrintHtmlBackgrounds { get; set; }
Property Value
Type Description
System.Boolean

RenderDelay

Milliseconds to wait after Html is rendered before printing. This can use useful when considering the rendering of JavaScript, Ajax or animations.

Declaration
public int RenderDelay { get; set; }
Property Value
Type Description
System.Int32

TextFooter

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

Declaration
public TextHeaderFooter TextFooter { get; set; }
Property Value
Type Description
TextHeaderFooter

TextHeader

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

Declaration
public TextHeaderFooter TextHeader { get; set; }
Property Value
Type Description
TextHeaderFooter

Timeout

Render timeout in seconds

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

ViewPortHeight

Defines a virtual screen height used to render HTML to PDF in IronPdf. Measured in pixels.

Viewport size is important in modern responsive HTML5 + CSS3 websites (e.g. Bootstrap framework websites) because the rendering and order of elements on the screen is dependent on viewport size.

The default viewport is 1280px wide by 1024px high to ensure the desktop version of a website is rendered unless otherwise specified. Smaller sizes (particularly width) will render responsive versions of many websites.

Declaration
public int ViewPortHeight { get; set; }
Property Value
Type Description
System.Int32

ViewPortWidth

Defines a virtual screen width used to render HTML to PDF in IronPdf. Measured in pixels.

Viewport size is important in modern responsive HTML5 + CSS3 websites (e.g. Bootstrap framework websites) because the rendering and order of elements on the screen is dependent on viewport size.

The default viewport is 1280px wide by 1024px high to ensure the desktop version of a website is rendered unless otherwise specified. Smaller sizes (particularly width) will render responsive versions of many website

Declaration
public int ViewPortWidth { get; set; }
Property Value
Type Description
System.Int32

Zoom

The zoom level in %. Enlarges the rendering size of Html documents.

Declaration
public int Zoom { get; set; }
Property Value
Type Description
System.Int32

Methods

Clone()

Supports 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