Class ChromeClient<T>

Chrome client implementation which uses interop to satisfy functionality using native code

ChromeClient utilize IronSoftware.JobQueue.JobQueueManager to queue requests to the native code

Inheritance

System.Object

ChromeClient<T>

Implements

System.IDisposable

Namespace: IronPdf.Engines.Chrome

Assembly: IronPdf.dll

Syntax

public class ChromeClient<T> : Object, IChromeClient, IDisposable where T : ChromeDeploymentBase

Type Parameters

Name	Description
T

Remarks

All HTML-to-PDF related logic should go here

Constructors

ChromeClient(IPdfClient)

Create a new local chrome client

Declaration

public ChromeClient(IPdfClient pdfClient)

Parameters

Type	Name	Description
IronSoftware.Pdfium.IPdfClient	pdfClient

Methods

AddHtmlHeadersAndFooters(IDocumentId, String, String, ChromePdfRenderOptions, List<Int32>, String, String, String)

Declaration

public void AddHtmlHeadersAndFooters(IDocumentId id, string owner_password, string user_password, ChromePdfRenderOptions Options, List<int> pages, string url, string htmlTitle, string pdfTitle)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	owner_password
System.String	user_password
ChromePdfRenderOptions	Options
System.Collections.Generic.List<System.Int32>	pages
System.String	url
System.String	htmlTitle
System.String	pdfTitle

AddStamp(IDocumentId, String, String, Stamper, IEnumerable<IPdfPage>)

Declaration

public void AddStamp(IDocumentId id, string owner_password, string user_password, Stamper Stamper, IEnumerable<IPdfPage> pages)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	owner_password
System.String	user_password
Stamper	Stamper
System.Collections.Generic.IEnumerable<IPdfPage>	pages

AddStamps(IDocumentId, String, String, IEnumerable<Stamper>, IEnumerable<IPdfPage>)

Declaration

public void AddStamps(IDocumentId id, string owner_password, string user_password, IEnumerable<Stamper> Stampers, IEnumerable<IPdfPage> pages)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	owner_password
System.String	user_password
System.Collections.Generic.IEnumerable<Stamper>	Stampers
System.Collections.Generic.IEnumerable<IPdfPage>	pages

ApplyCookies(String, Dictionary<String, String>)

Declaration

public void ApplyCookies(string url, Dictionary<string, string> cookies)

Parameters

Type	Name	Description
System.String	url
System.Collections.Generic.Dictionary<System.String, System.String>	cookies

ClearCookies()

Declaration

public void ClearCookies()

Dispose()

Declaration

public virtual void Dispose()

ExtractImagesFromMultiFrameImageFormats(List<String>)

Declaration

public static (List<string>, List<string>) ExtractImagesFromMultiFrameImageFormats(List<string> imagePathList)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	imagePathList

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.List<System.String>, System.Collections.Generic.List<System.String>>

Finalize()

Declaration

protected override void Finalize()

Initialize()

Declaration

protected virtual void Initialize()

MeasureHTML(String, Uri, String, ChromePdfRenderOptions)

Measure the size of an HTML fragment.

Declaration

public Size MeasureHTML(string html, Uri baseUrl, string proxy, ChromePdfRenderOptions renderOptions)

Parameters

Type	Name	Description
System.String	html	The HTML fragment to measure.
System.Uri	baseUrl	Optional: a base URL.
System.String	proxy	Optional: a proxy.
ChromePdfRenderOptions	renderOptions	Render options to use when rendering the HTML fragment.

Returns

Type	Description
SixLabors.ImageSharp.Size	The size of the HTML fragment.

RenderPDFFromFile(ChromePdfRenderOptions, ChromeHttpLoginCredentials, String)

Declaration

public (IDocumentId, string) RenderPDFFromFile(ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials, string filePath)

Parameters

Type	Name	Description
ChromePdfRenderOptions	renderOptions
ChromeHttpLoginCredentials	loginCredentials
System.String	filePath

Returns

Type	Description
System.ValueTuple<IronSoftware.IDocumentId, System.String>

RenderPDFFromHTML(String, Uri, String, ChromePdfRenderOptions, ChromeHttpLoginCredentials)

Declaration

public (IDocumentId, string) RenderPDFFromHTML(string html, Uri baseUrl, string proxy, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)

Parameters

Type	Name	Description
System.String	html
System.Uri	baseUrl
System.String	proxy
ChromePdfRenderOptions	renderOptions
ChromeHttpLoginCredentials	loginCredentials

Returns

Type	Description
System.ValueTuple<IronSoftware.IDocumentId, System.String>

RenderPDFFromImages(List<String>, IEnumerable<(Byte[], String)>, ImageBehavior, ChromePdfRenderOptions)

Declaration

public IDocumentId RenderPDFFromImages(List<string> imagePathList, IEnumerable<(byte[], string)> images, ImageBehavior behavior, ChromePdfRenderOptions RenderingOptions)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	imagePathList
System.Collections.Generic.IEnumerable<System.ValueTuple<System.Byte[], System.String>>	images
ImageBehavior	behavior
ChromePdfRenderOptions	RenderingOptions

Returns

Type	Description
IronSoftware.IDocumentId

RenderPDFFromURI(Uri, ChromePdfRenderOptions, ChromeHttpLoginCredentials)

Declaration

public IDocumentId RenderPDFFromURI(Uri url, ChromePdfRenderOptions RenderingOptions, ChromeHttpLoginCredentials LoginCredentials)

Parameters

Type	Name	Description
System.Uri	url
ChromePdfRenderOptions	RenderingOptions
ChromeHttpLoginCredentials	LoginCredentials

Returns

Type	Description
IronSoftware.IDocumentId

RenderPDFFromZIP(in Byte[], String, ChromePdfRenderOptions, ChromeHttpLoginCredentials)

Declaration

public (IDocumentId, string) RenderPDFFromZIP(in byte[] bytes, string mainFile, ChromePdfRenderOptions RenderingOptions, ChromeHttpLoginCredentials LoginCredentials)

Parameters

Type	Name	Description
System.Byte[]	bytes
System.String	mainFile
ChromePdfRenderOptions	RenderingOptions
ChromeHttpLoginCredentials	LoginCredentials

Returns

Type	Description
System.ValueTuple<IronSoftware.IDocumentId, System.String>

Implements

System.IDisposable