Table of Contents

Interface IPdfGeneratorFinal

Namespace
CobaltPdf.WebKit
Assembly
CobaltPDF.WebKit.dll

Continuation of the fluent chain after WithCustomJS has been called.

public interface IPdfGeneratorFinal

Methods

AddCookie(string, string, string?, string)

IPdfGeneratorFinal AddCookie(string name, string value, string? domain = null, string path = "/")

Parameters

name string
value string
domain string
path string

Returns

IPdfGeneratorFinal

AddLocalStorage(string, string)

IPdfGeneratorFinal AddLocalStorage(string key, string value)

Parameters

key string
value string

Returns

IPdfGeneratorFinal

AddSessionStorage(string, string)

IPdfGeneratorFinal AddSessionStorage(string key, string value)

Parameters

key string
value string

Returns

IPdfGeneratorFinal

RenderHtmlAsPdfAsync(string, CancellationToken)

Task<PdfDocument> RenderHtmlAsPdfAsync(string html, CancellationToken cancellationToken = default)

Parameters

html string
cancellationToken CancellationToken

Returns

Task<PdfDocument>

RenderHtmlFileAsPdfAsync(string, CancellationToken)

Task<PdfDocument> RenderHtmlFileAsPdfAsync(string filePath, CancellationToken cancellationToken = default)

Parameters

filePath string
cancellationToken CancellationToken

Returns

Task<PdfDocument>

RenderUrlAsPdfAsync(string, CancellationToken)

Task<PdfDocument> RenderUrlAsPdfAsync(string url, CancellationToken cancellationToken = default)

Parameters

url string
cancellationToken CancellationToken

Returns

Task<PdfDocument>

WithCspBypass(bool)

IPdfGeneratorFinal WithCspBypass(bool enable = true)

Parameters

enable bool

Returns

IPdfGeneratorFinal

WithCustomJS(string)

[Obsolete("CobaltPdf: WithCustomJS has already been called. Combine your scripts into one block.", true)]
IPdfGeneratorFinal WithCustomJS(string script)

Parameters

script string

Returns

IPdfGeneratorFinal

WithEncryption(PdfEncryptionOptions)

IPdfGeneratorFinal WithEncryption(PdfEncryptionOptions encryption)

Parameters

encryption PdfEncryptionOptions

Returns

IPdfGeneratorFinal

WithFonts(string)

IPdfGeneratorFinal WithFonts(string fontDirectoryPath)

Parameters

fontDirectoryPath string

Returns

IPdfGeneratorFinal

WithFooter(string)

IPdfGeneratorFinal WithFooter(string htmlOrFilePath)

Parameters

htmlOrFilePath string

Returns

IPdfGeneratorFinal

WithGrayscale()

IPdfGeneratorFinal WithGrayscale()

Returns

IPdfGeneratorFinal

WithHeader(string)

IPdfGeneratorFinal WithHeader(string htmlOrFilePath)

Parameters

htmlOrFilePath string

Returns

IPdfGeneratorFinal

WithHttpHeader(string, string)

IPdfGeneratorFinal WithHttpHeader(string name, string value)

Parameters

name string
value string

Returns

IPdfGeneratorFinal

WithHttpHeaders(IDictionary<string, string>)

IPdfGeneratorFinal WithHttpHeaders(IDictionary<string, string> headers)

Parameters

headers IDictionary<string, string>

Returns

IPdfGeneratorFinal

WithLandscape()

IPdfGeneratorFinal WithLandscape()

Returns

IPdfGeneratorFinal

WithLazyLoadPages(int, TimeSpan?, TimeSpan?)

IPdfGeneratorFinal WithLazyLoadPages(int pageCount, TimeSpan? delay = null, TimeSpan? timeout = null)

Parameters

pageCount int
delay TimeSpan?
timeout TimeSpan?

Returns

IPdfGeneratorFinal

WithMargins(MarginOptions)

IPdfGeneratorFinal WithMargins(MarginOptions margins)

Parameters

margins MarginOptions

Returns

IPdfGeneratorFinal

WithMediaType(CssMediaType)

IPdfGeneratorFinal WithMediaType(CssMediaType type)

Parameters

type CssMediaType

Returns

IPdfGeneratorFinal

WithMetadata(Action<MetadataOptions>)

IPdfGeneratorFinal WithMetadata(Action<MetadataOptions> configure)

Parameters

configure Action<MetadataOptions>

Returns

IPdfGeneratorFinal

WithPageRanges(string)

IPdfGeneratorFinal WithPageRanges(string ranges)

Parameters

ranges string

Returns

IPdfGeneratorFinal

WithPageSize(string, string)

IPdfGeneratorFinal WithPageSize(string width, string height)

Parameters

width string
height string

Returns

IPdfGeneratorFinal

WithPaperFormat(string)

IPdfGeneratorFinal WithPaperFormat(string format)

Parameters

format string

Returns

IPdfGeneratorFinal

WithPrintBackground(bool)

IPdfGeneratorFinal WithPrintBackground(bool enable = true)

Parameters

enable bool

Returns

IPdfGeneratorFinal

WithReloadAfterStorage()

IPdfGeneratorFinal WithReloadAfterStorage()

Returns

IPdfGeneratorFinal

WithScale(float)

IPdfGeneratorFinal WithScale(float scale)

Parameters

scale float

Returns

IPdfGeneratorFinal

WithUserAgent(string)

IPdfGeneratorFinal WithUserAgent(string userAgent)

Parameters

userAgent string

Returns

IPdfGeneratorFinal

WithWaitStrategy(WaitOptions)

IPdfGeneratorFinal WithWaitStrategy(WaitOptions strategy)

Parameters

strategy WaitOptions

Returns

IPdfGeneratorFinal

WithWatermark(WatermarkOptions)

IPdfGeneratorFinal WithWatermark(WatermarkOptions watermark)

Parameters

watermark WatermarkOptions

Returns

IPdfGeneratorFinal