Table of Contents

Class DocumentRenderer

Namespace
MigraDoc.Rendering
Assembly
MigraDoc.Rendering.dll

Provides methods to render the document or single parts of it to a XGraphics object.

public class DocumentRenderer
Inheritance
object
DocumentRenderer

Remarks

One prepared instance of this class can serve to render several output formats.

Constructors

DocumentRenderer(Document)

Provides methods to render the document or single parts of it to a XGraphics object.

Properties

FormattedDocument

Gets the formatted document of this instance. Will be null if document was not yet prepared.

HasPrepareDocumentProgress

Gets a value indicating whether this instance supports PrepareDocumentProgress.

PrintDate

Gets or sets the print date, i.e. the rendering date.

WorkingDirectory

Gets or sets the working directory for rendering.

Methods

GetDocumentObjectsFromPage(int)

Gets the document objects that get rendered on the specified page.

GetRenderInfoFromPage(int)

Gets the render information for document objects that get rendered on the specified page.

PrepareDocument(RenderEvents?)

Prepares this instance for rendering. Commit renderEvents to allow RenderTextEvent calls.

RenderObject(XGraphics, XUnitPt, XUnitPt, XUnitPt, DocumentObject)

Renders a single object to the specified graphics object at the given point.

RenderPage(XGraphics, int)

Renders a MigraDoc document to the specified graphics object.

RenderPage(XGraphics, int, PageRenderOptions)

Renders a MigraDoc document to the specified graphics object.

Events

PrepareDocumentProgress

Occurs while the document is being prepared (can be used to show a progress bar).