Search Results for

    Show / Hide Table of Contents

    Class ChromePdfRenderer

    IronPdf.ChromePdfRenderer allows any web page or Html 'snippet' to be turned into a PDF document using an up-to-date embedded Chrome browser.

    As of 2021 Iron Software recommend ChromePdfRenderer as our best PDF Renderer and a drop-in replacement for this class.

    Inheritance
    System.Object
    BasePdfRenderer
    ChromePdfRenderer
    Implements
    IPdfRenderer
    Inherited Members
    BasePdfRenderer.RenderHtmlAsPdf(String, Uri, String)
    BasePdfRenderer.RenderHtmlAsPdf(String, String, String)
    BasePdfRenderer.RenderHtmlFileAsPdf(String)
    BasePdfRenderer.RenderUrlAsPdf(String)
    BasePdfRenderer.RenderUrlAsPdf(Uri)
    BasePdfRenderer.RenderRtfFileAsPdf(String)
    BasePdfRenderer.RenderMarkdownFileAsPdf(String)
    BasePdfRenderer.RenderRtfStringAsPdf(String)
    BasePdfRenderer.RenderMarkdownStringAsPdf(String)
    BasePdfRenderer.RenderHtmlAsPdfAsync(String, Uri)
    BasePdfRenderer.RenderHtmlFileAsPdfAsync(String)
    BasePdfRenderer.RenderUrlAsPdfAsync(Uri)
    BasePdfRenderer.RenderUrlAsPdfAsync(String)
    BasePdfRenderer.RenderZipFileAsPdf(String, String)
    BasePdfRenderer.RenderingOptions
    BasePdfRenderer.LoginCredentials
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: IronPdf
    Assembly: IronPdf.dll
    Syntax
    public class ChromePdfRenderer : BasePdfRenderer, IPdfRenderer

    Constructors

    ChromePdfRenderer()

    Create a new Chrome Html To PDF renderer.

    Declaration
    public ChromePdfRenderer()

    Methods

    ApplyCookies(String, ChromeHttpLoginCredentials)

    Applies cookies from the specified login credentials class to the specified url

    Declaration
    public static void ApplyCookies(string Url, ChromeHttpLoginCredentials Login)
    Parameters
    Type Name Description
    System.String Url

    Url cookies will apply to

    ChromeHttpLoginCredentials Login

    Login credentials which includes CustomCookies property

    ClearCookies()

    Clear cookies for all urls

    Declaration
    public static void ClearCookies()

    StaticRenderHtmlAsPdf(String, ChromePdfRenderOptions, String)

    Creates a PDF file from an Html string, and returns it as an PdfDocument object which can be edited and saved to disk or served on a website.

    Static version of the RenderHtmlAsPdf method.

    Declaration
    public static PdfDocument StaticRenderHtmlAsPdf(string Html, ChromePdfRenderOptions Options = null, string Proxy = null)
    Parameters
    Type Name Description
    System.String Html

    The Html to be rendered as a PDF.

    ChromePdfRenderOptions Options

    An instance of ChromePdfRenderOptions that allows configuration of Chrome "HTML to PDF" rendering parameters.

    System.String Proxy

    Specifies an Http proxy server. Use the pattern: http(s)://user-name:password@host:port

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Html rendered as its contents.

    StaticRenderHtmlAsPdf(String, String, ChromePdfRenderOptions, String)

    Creates a PDF file from an Html string, and returns it as an PdfDocument object which can be edited and saved to disk or served on a website.

    Static version of the RenderHtmlAsPdf method.

    Declaration
    public static PdfDocument StaticRenderHtmlAsPdf(string Html, string BaseUrlOrPath, ChromePdfRenderOptions Options = null, string Proxy = null)
    Parameters
    Type Name Description
    System.String Html

    The Html to be rendered as a PDF.

    System.String BaseUrlOrPath

    Setting the BaseURL property gives the relative context for hyper-links, images, CSS and JavaScript files. May be a remote URL or local file path.

    ChromePdfRenderOptions Options

    An instance of ChromePdfRenderOptions that allows configuration of Chrome "HTML to PDF" rendering parameters.

    System.String Proxy

    Specifies an Http proxy server. Use the pattern: http(s)://user-name:password@host:port

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Html rendered as its contents.

    StaticRenderHtmlAsPdf(String, Uri, ChromePdfRenderOptions, String)

    Creates a PDF file from an Html string, and returns it as an PdfDocument object which can be edited and saved to disk or served on a website.

    Static version of the RenderHtmlAsPdf method.

    Declaration
    public static PdfDocument StaticRenderHtmlAsPdf(string Html, Uri BaseUrl, ChromePdfRenderOptions Options = null, string Proxy = null)
    Parameters
    Type Name Description
    System.String Html

    The Html to be rendered as a PDF.

    System.Uri BaseUrl

    Setting the BaseURL property gives the relative context for hyper-links, images, CSS and JavaScript files. May be a remote URL or local file path.

    ChromePdfRenderOptions Options

    An instance of ChromePdfRenderOptions that allows configuration of Chrome "HTML to PDF" rendering parameters.

    System.String Proxy

    Specifies an Http proxy server. Use the pattern: http(s)://user-name:password@host:port

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Html rendered as its contents.

    StaticRenderHtmlAsPdfAsync(String, Uri, ChromePdfRenderOptions)

    Creates a PDF file from an Html string, and returns it as an PdfDocument object which can be edited and saved to disk or served on a website.

    Static Async version of the RenderHtmlAsPdf method.

    Declaration
    public static Task<PdfDocument> StaticRenderHtmlAsPdfAsync(string Html, Uri BaseUrl = null, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String Html

    The Html to be rendered as a PDF.

    System.Uri BaseUrl

    Setting the BaseURL property gives the relative context for hyper-links, images, CSS and JavaScript files. May be a remote URL or local file path.

    ChromePdfRenderOptions Options

    An instance of ChromePdfRenderOptions that allows configuration of Chrome "HTML to PDF" rendering parameters.

    Returns
    Type Description
    System.Threading.Tasks.Task<PdfDocument>

    A PdfDocument with the Html rendered as its contents.

    StaticRenderHTMLFileAsPdf(String, ChromePdfRenderOptions)

    Renders an HTML file as a PDF file. Returns a PdfDocument object which may be edited and saved to disk or served on a website.

    Static version of the RenderHTMLFileAsPdf method.

    Declaration
    public static PdfDocument StaticRenderHTMLFileAsPdf(string FilePath, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String FilePath

    Path to an Html file.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Html file rendered as its contents..

    StaticRenderHTMLFileAsPdfAsync(String, ChromePdfRenderOptions)

    Renders an HTML file as a PDF file. Returns a PdfDocument object which may be edited and saved to disk or served on a website.

    Static Async version of the RenderHTMLFileAsPdf method.

    Declaration
    public static Task<PdfDocument> StaticRenderHTMLFileAsPdfAsync(string FilePath, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String FilePath

    Path to an Html file.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    System.Threading.Tasks.Task<PdfDocument>

    A PdfDocument with the Html file rendered as its contents.

    StaticRenderUrlAsPdf(String, ChromePdfRenderOptions)

    Renders all Html and assets at a given Url into a PDF file using IronPdf's embedded Chrome browser as the rendering engine.

    Static version of the RenderUrlAsPdf method.

    Declaration
    public static PdfDocument StaticRenderUrlAsPdf(string UrlOrPath, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String UrlOrPath

    An absolute Url. Points to the Html document to be rendered as a PDF.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Url rendered as its contents.

    StaticRenderUrlAsPdf(Uri, ChromePdfRenderOptions)

    Renders all Html and assets at a given Url into a PDF file using IronPdf's embedded Chrome browser as the rendering engine.

    Static version of the RenderUrlAsPdf method.

    Declaration
    public static PdfDocument StaticRenderUrlAsPdf(Uri Url, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.Uri Url

    An absolute Uri. Points to the Html document or local file file to be rendered as a PDF.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    PdfDocument

    A PdfDocument with the Url rendered as its contents.

    StaticRenderUrlAsPdfAsync(String, ChromePdfRenderOptions)

    Renders all Html and assets at a given Url into a PDF file using IronPdf's embedded Chrome browser as the rendering engine.

    Static Async version of the RenderUrlAsPdf method.

    Declaration
    public static Task<PdfDocument> StaticRenderUrlAsPdfAsync(string UrlOrPath, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String UrlOrPath

    An absolute Url. Points to the Html document or local file to be rendered as a PDF.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    System.Threading.Tasks.Task<PdfDocument>

    A PdfDocument with the Url rendered as its contents.

    StaticRenderUrlAsPdfAsync(Uri, ChromePdfRenderOptions)

    Renders all Html and assets at a given Url into a PDF file using IronPdf's embedded Chrome browser as the rendering engine.

    Static Async version of the RenderUrlAsPdf method.

    Declaration
    public static Task<PdfDocument> StaticRenderUrlAsPdfAsync(Uri Url, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.Uri Url

    An absolute Uri. Points to the Html document or local file file to be rendered as a PDF.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    System.Threading.Tasks.Task<PdfDocument>

    A PdfDocument with the Url rendered as its contents.

    StaticRenderZipFileAsPdf(String, String, ChromePdfRenderOptions)

    Creates a PDF file from a local Zip file, and returns it as a PdfDocument.

    IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
    - Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
    - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
    - Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/

    Declaration
    public static PdfDocument StaticRenderZipFileAsPdf(string FilePath, string MainFile, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String FilePath

    Path to an Zip to be rendered as a PDF.

    System.String MainFile

    Name of the primary HTML file.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    PdfDocument

    A PdfDocument

    StaticRenderZipFileAsPdfAsync(String, String, ChromePdfRenderOptions)

    Creates a PDF file from a local Zip file, and returns it as a PdfDocument.

    IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
    - Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
    - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
    - Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/

    Static Async version of the RenderZipFileAsPdf method.

    Declaration
    public static Task<PdfDocument> StaticRenderZipFileAsPdfAsync(string FilePath, string MainFile, ChromePdfRenderOptions Options = null)
    Parameters
    Type Name Description
    System.String FilePath

    Path to an Zip to be rendered as a PDF.

    System.String MainFile

    Name of the primary HTML file.

    ChromePdfRenderOptions Options

    Optional print options and settings as an instance of ChromePdfRenderOptions.

    Returns
    Type Description
    System.Threading.Tasks.Task<PdfDocument>

    A PdfDocument

    Implements

    IPdfRenderer

    Inherited members

    RenderHtmlAsPdf(String, Uri, String)
    RenderHtmlAsPdf(String, String, String)
    RenderHtmlFileAsPdf(String)
    RenderUrlAsPdf(String)
    RenderUrlAsPdf(Uri)
    RenderRtfFileAsPdf(String)
    RenderMarkdownFileAsPdf(String)
    RenderRtfStringAsPdf(String)
    RenderMarkdownStringAsPdf(String)
    RenderHtmlAsPdfAsync(String, Uri)
    RenderHtmlFileAsPdfAsync(String)
    RenderUrlAsPdfAsync(Uri)
    RenderUrlAsPdfAsync(String)
    RenderZipFileAsPdf(String, String)
    RenderingOptions
    LoginCredentials
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Free 30-Day Trial Key
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronPDF to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronPDF free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.