Click or drag to resize

PdfARenderer Class

PdfARenderer is a concrete implementation of the DocumentRenderer class. It is responsible for creating PDF/A files/streams from PdfGeneratedDocument objects. During render operations different PDF/A specific exceptions can occur. See the Exceptions section for details.
Inheritance Hierarchy
SystemObject
  Atalasoft.PdfDoc.Generating.RenderingDocumentRenderer
    Atalasoft.PdfDoc.Generating.RenderingPdfRenderer
      Atalasoft.PdfDoc.Generating.RenderingPdfARenderer

Namespace:  Atalasoft.PdfDoc.Generating.Rendering
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
Copy
public class PdfARenderer : PdfRenderer

The PdfARenderer type exposes the following members.

Constructors
  NameDescription
Public methodPdfARenderer
Initializes a new instance of the PdfARenderer class.
Top
Properties
  NameDescription
Public propertyCmykColorSpace
Gets or sets the CMYK color space that will be provided to each CMYK image.
Public propertyConvertIncompatiblePagesToImages
Gets or sets a value indicating whether the page that cannot be converted to PDF/A, will be converted to the image, instead of throwing PdfAException. ImageExtractor is required to use this flag.
Protected propertyCurrentPage (Inherited from PdfRenderer.)
Public propertyDefaultRgbColorSpace
Gets default RGB color space resource.
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.
(Inherited from DocumentRenderer.)
Public propertyIgnoreUnsupportedAnnotsAndActions
Gets or sets a value indicating whether annotations and actions that not supported by the PDF/A-1b standard will be ignored, instead of throwing PdfAException.
Public propertyImageExtractor
Gets or sets the image extractor.
Public propertyRgbColorSpace
Gets or sets the RGB color space that will be used in OutputIntents of PDF/A document. If value is not specified, DefaultRgbColorSpace will be used.
Protected propertySaveOptions (Inherited from PdfRenderer.)
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 (Overrides PdfRendererLLBeginDoc(PdfGeneratedDocument).)
Protected methodLLBeginPage
Low Level the begin page.
(Inherited from PdfRenderer.)
Protected methodLLEndDoc (Overrides PdfRendererLLEndDoc(PdfGeneratedDocument).)
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.
(Inherited from PdfRenderer.)
Protected methodLLGenerate (Overrides PdfRendererLLGenerate(PdfGeneratedDocument, BasePage, PdfPageRenderer).)
Protected methodMakePageRenderer
Makes the page renderer.
(Inherited from PdfRenderer.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDocumentProgress
Raises the [E:DocumentProgress] event.
(Inherited from DocumentRenderer.)
Protected methodOnStreamlessFontFound
Protected methodPreprocessPageResources (Overrides PdfRendererPreprocessPageResources(PdfPageRenderer, PdfGeneratedPage).)
Public methodRender(PdfGeneratedDocument)
Renders the entire PdfGeneratedDocument.
(Inherited from DocumentRenderer.)
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.
(Inherited from DocumentRenderer.)
Protected methodRenderBookmarkTree (Inherited from PdfRenderer.)
Protected methodRenderForm (Overrides PdfRendererRenderForm(PdfGeneratedDocument, Boolean).)
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.
(Inherited from DocumentRenderer.)
Public eventStreamlessFontFound
Occurs when not embedded font will be found.
Top
Exceptions
ExceptionCondition
PdfAActionExceptionOccurs, when input document contains actions unsupported by PDF/A.
PdfAAnnotationExceptionOccurs, when input document contains annotations unsupported by PDF/A, or when annotation appearance doesn't complaint PDF/A.
PdfAExceptionGeneral error. See the exception message for details.
PdfAImageAndColorSpaceExceptionOccurs, when input PDF document contains content with CMYK colorspace and property CmykColorSpace is not set.
PdfAFontExceptionOccurs, when PdfARenderer can't create PDF/A complaint document because of issues with fonts. See the details in exception message.
Examples
Copy
public MemoryStream SaveToMemoryStream(PdfGeneratedDocument doc)
{
    MemoryStream stm = new MemoryStream();
    PdfARenderer renderer = new PdfARenderer(stm);
    renderer.Render(doc);
    return stm;
}
See Also