PDFDocumentRenderer¶

Namespace: O2S.Components.PDF4NET.Rendering

Defines a renderer for a PDF document.

public class PDFDocumentRenderer

Inheritance Object → PDFDocumentRenderer

Constructors¶

PDFDocumentRenderer(PDFFixedDocument)¶

Initializes a new PDFDocumentRenderer object.

public PDFDocumentRenderer(PDFFixedDocument document)

Parameters

document PDFFixedDocument
The document to be rendered.

Properties¶

RenderingErrors¶

Gets the errors that appeared during rendering.

public PDFRenderingError[] RenderingErrors { get; }

Property Value

PDFRenderingError[]
An array of PDFRenderingError objects or null if there were no errors during rendering.

Remarks

When the PDFRendererSettings.ErrorHandling property is set to any of the "Ignore" modes then this property is filled with the errors that appeared during rendering.

Methods¶

ConvertToMultipageImage(PDFRendererSettings, Stream)¶

Converts the entire PDF document to a multipage TIFF image.

public void ConvertToMultipageImage(PDFRendererSettings settings, Stream output)

Parameters

settings PDFRendererSettings
Settings used during the rendering process.

output Stream
Output stream where the image will be stored.

ConvertToMultipageImage(String, PDFRendererSettings, Stream)¶

Converts the PDF document to a multipage TIFF image.

public void ConvertToMultipageImage(string pageRange, PDFRendererSettings settings, Stream output)

Parameters

pageRange String
Range of pages to convert to image.

settings PDFRendererSettings
Settings used during the rendering process.

output Stream
Output stream where the image will be stored.

ConvertToMultipageImage(String, PDFRendererSettings, PDFPageImageFormat, Stream)¶

Converts the PDF document to a multipage TIFF image.

public void ConvertToMultipageImage(string pageRange, PDFRendererSettings settings, PDFPageImageFormat imageFormat, Stream output)

Parameters

pageRange String
Range of pages to convert to image.

settings PDFRendererSettings
Settings used during the rendering process.

imageFormat PDFPageImageFormat
The type of the output TIFF image

output Stream
Output stream where the image will be stored.

Events¶

PageRenderingCompleted¶

Gets or sets the event that is fired after a page has been rendered.

public event EventHandler<PDFPageRenderingCompletedEventArgs> PageRenderingCompleted;

Remarks

If the Cancel property in the event args has been set to true then the following pages are no longer rendered.