Click or drag to resize

DocumentRenderer Class

The DocumentRenderer class is an abstract class that defines how a PdfGeneratedDocument is rendered into some other form. DocumentRenderer defines the process of rendering, but doesn't define the actual steps. In this way one concrete instance of DocumentRenderer could create a PDF file from a PdfGeneratedDocument and another could create a WPF approximation of a single page within a PdfGeneratedDocument, but both renderers could be treated the same in client code.
Inheritance Hierarchy
SystemObject
  Atalasoft.PdfDoc.Generating.RenderingDocumentRenderer
    Atalasoft.PdfDoc.Generating.RenderingPdfRenderer

Namespace:  Atalasoft.PdfDoc.Generating.Rendering
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public abstract class DocumentRenderer

The DocumentRenderer type exposes the following members.

Constructors
  NameDescription
Protected methodDocumentRenderer
Initializes a new instance of the DocumentRenderer class
Top
Properties
  NameDescription
Protected propertyErrorOccurred
Gets or sets a value indicating whether an error occurred in the process of rendering a page. ErrorOccurred will be cleared before rendering begins.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodLLBeginDoc
This method represents the Low-Level implementation of BeginDoc. It is called once at the start of rendering the document after the first DocumentProgress event has been fired, but before the first page is rendered. If a document has an empty Pages collection, LLBeginDoc will not be called. The default implementation does nothing.
Protected methodLLBeginPage
This method represents the Low-Level implementation of BeginPage. A subclass of DocumentRenderer would implement this method to do any processing to set up for rendering a given page. For exmaple, a particular rendered might need to create GDI Graphics objects or clear a frame buffer before rendering a page.
Protected methodLLEndDoc
This method represents the Low-Level implementation of EndDoc. It is called once at the end of rendering a document after the final DocumentProgress event has been fired. If a document has an empty Pages collection, LLEndDoc will not be called. A concrete implementation of DocumentRenderer could use this method for cleaning up temporary files created during the rendering process.
Protected methodLLEndPage
This method represents the Low-Level implementation of EndPage. A subclass of DocumentRenderer would implement this method to do any processing to finish up after a page has been rendered. For example, a particular instance might need to remove temporary files created earlier. The default implementation does nothing.
Protected methodLLGenerate
This method represents the Low-Level implementation of code used to generate PDF content for a particular page. A complete implementation of this method should call the GeneratePdf method of the page's DrawlingList property, passing in the given PdfPageRenderer object. The default implementation does nothing.
Protected methodMakePageRenderer
Makes the PdfPageRenderer that will be used for each page being rendered. When rendering a document, MakeWriter will be called once for every page that is rendered. A concrete implementation of DocumentRenderer must implement this method.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDocumentProgress
Raises the [E:DocumentProgress] event.
Public methodRender(PdfGeneratedDocument)
Renders the entire PdfGeneratedDocument.
Public methodCode exampleRender(PdfGeneratedDocument, ICollectionBasePage)
Renders a subset of pages from the specified document. This method is intended to allow the rendering of a subset of pages from a document. If pages is an empty enumeration, the output is undefined.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventDocumentProgress
Occurs when progress is made in the overall process of rendering the document. This event is fired when rendering starts, when rendering completes, when each page starts and when each page completes. If the document contains no pages, then precisely one DocumentProgress event will be fired.
Top
See Also