Method Render

Namespace

DocWright.Renderers.Imaging

Assembly

DocWright.Renderers.Imaging.dll

Render(ILaidOutDocument, Stream, RenderOptions, IConversionDiagnostics)

Renders the document to the output stream in a single forward-only pass.

public void Render(ILaidOutDocument document, Stream output, RenderOptions options, IConversionDiagnostics diagnostics)

Parameters

document ILaidOutDocument

The laid-out document.

output Stream

The stream to write to, forward-only.

options RenderOptions

The render options.

diagnostics IConversionDiagnostics

The diagnostics sink.

Render(ILaidOutDocument, Stream, RenderOptions, IConversionDiagnostics, CancellationToken, Action<int, int>?)

Renders with cancellation and a page-boundary callback.

public void Render(ILaidOutDocument document, Stream output, RenderOptions options, IConversionDiagnostics diagnostics, CancellationToken cancellationToken, Action<int, int>? pageBoundaryCallback)

Parameters

document ILaidOutDocument

The laid-out document.

output Stream

The stream for the single-page path; unused when a page stream factory is set.

options RenderOptions

The render options.

diagnostics IConversionDiagnostics

The diagnostics sink.

cancellationToken CancellationToken

Cancels between pages.

pageBoundaryCallback Action<int, int>

Receives (completed, total) after each page.

Exceptions

ArgumentNullException

An argument is null.

OperationCanceledException

Cancellation was requested.