PDFDraw Class

PDFDraw contains methods for converting PDF pages to images and to Bitmap objects. Utility methods are provided to export PDF pages to various raster formats.

Inheritance Hierarchy

SystemObject
pdftron.PDFPDFDraw

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class PDFDraw : IClosable

Public NotInheritable Class PDFDraw
	Implements IClosable

public ref class PDFDraw sealed : IClosable

pdftron.PDF.PDFDraw = function();

Type.createClass(
	'pdftron.PDF.PDFDraw',
	null,
	Windows.Foundation.IClosable);

The PDFDraw type exposes the following members.

Constructors

	Name	Description
	PDFDraw	Creates a new PDFDraw instance.
	PDFDraw(Double)	Creates a new PDFDraw instance.

Top

Methods

	Name	Description
	Close
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Export(Page, String)	Exports a page to an image.
	Export(Page, String, String)	Exports a page to an image.
	Export(Page, String, String, Obj)	Exports a page to an image.
	ExportAsStreamAsync	Exports a page to an image as a stream, including header. This stream is can be used in JavaScript's URL.createObjectURL to create a source for an image. If the image is rendered as a bitmap, it can also be used in C# with BitmapImage.SetSource[Async].
	ExportAsync(Page, IFilter, String)	Exports a page to an image.
	ExportAsync(Page, IFilter, String, Obj)	Exports a page to an image.
	GetBitmapAsync	Gets the bitmap for a given page asynchronously.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRawBitmapAsync	Gets the raw bitmap for a given page asynchronously.
	GetSeparationBitmaps	Gets the Separations from the page
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetAntiAliasing	Enable or disable support for overprint. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). By default overprint is enabled for only PDF/X files.
	SetCaching	Sets the caching.
	SetClipRect	Clip the render region to the provided rect (in page space)
	SetColorPostProcessMode	Draws the page into a given memory buffer. Set the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output.
	SetDefaultPageColor	Sets the default color of the page backdrop.
	SetDPI	Sets the output image resolution.
	SetDrawAnnotations	Enables or disables annotation and forms rendering. By default, all annotations and form fields are rendered.
	SetFlipYAxis	Flips the vertical (i.e. Y) axis of the image.
	SetGamma	Sets the gamma factor used for anti-aliased rendering.
	SetHighlightFields	Enables or disables highlighting form fields. Default is disabled.
	SetImageSize(Int32, Int32)	Sets the size of the image.
	SetImageSize(Int32, Int32, Boolean, Boolean)	Sets the image size.
	SetImageSmoothing	Enable or disable image smoothing. The rasterizer allows a tradeoff between rendering quality and rendering speed. This function can be used to indicate the preference between rendering speed and quality. image smoothing is enabled by default.
	SetOCGContext
	SetPageBox	Selects the page box/region to rasterize.
	SetPageTransparent	Sets the page color to transparent. By default, PDFDraw assumes that the page is imposed directly on an opaque white surface. Some applications may need to impose the page on a different backdrop. In this case any pixels that are not covered during rendering will be transparent.
	SetPathHinting	Enable or disable path hinting. Path hinting is used to slightly adjust paths in order to avoid or alleviate artifacts of hair line cracks between certain graphical elements. This option is turned on by default.
	SetPrintMode	Tells the rasterizer to render the page 'print' mode. Certain page elements (such as annotations or OCG-s) are meant to be visible either on the screen or on the printed paper but not both. A common example, is the "Submit" button on electronic forms.
	SetRotate	Sets the rotation value for this page.
	SetThinLineAdjustment	Set thin line adjustment parameters.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is available on all platforms supported by PDFNet.

Reference

pdftron.PDF Namespace