PdfEncoder Class

An ImageEncoder that will write one or more images to a PDF file.

Inheritance Hierarchy

System.Object
  Atalasoft.Imaging.Codec.ImageEncoder
    Atalasoft.Imaging.Codec.MultiFramedImageEncoder
      Atalasoft.Imaging.Codec.Pdf.PdfEncoder

Namespace: Atalasoft.Imaging.Codec.Pdf
Assembly: Atalasoft.dotImage.Pdf (in Atalasoft.dotImage.Pdf.dll) Version: 11.4.0.0.0.251 (.NET 4.5.2, x86)

Syntax

Copy

public class PdfEncoder : MultiFramedImageEncoder

Public Class PdfEncoder
	Inherits MultiFramedImageEncoder

The PdfEncoder type exposes the following members.

Constructors

	Name	Description
	PdfEncoder()	Creates a new instance of PdfEncoder.
	PdfEncoder(PdfDocumentType)	Creates a new instance of PdfEncoder specifying the document type.
	PdfEncoder(PdfMetadata)	Creates a new instance of PdfEncoder specifying metadata.
	PdfEncoder(PdfPageSizeMode, Size, Int32, PdfMetadata)	Creates a new instance of PdfEncoder specifying sizeMode, pageSize, pageBorder and metadata.
	PdfEncoder(Int32, PdfPageSizeMode, Size, Int32, PdfMetadata)	Creates an instance of PdfEncoder specifying jpegQuality, sizeMode, pageSize, pageBorder and metadata.
	PdfEncoder(PdfPageSizeMode, Size, Int32, PdfMetadata, PdfDocumentType)	Creates a new instance of PdfEncoder specifying sizeMode, pageSize, pageBorder, metadata and document type.

Top

Properties

	Name	Description
	AdjustPdfVersionAsNeeded	Gets or sets a value indicating whether to adjust PDF version as needed. If the document is saved using features that surpass the version of the PDF spec to adhere to specified in PdfVersion, this will automatically adjust the version to match.
	BookmarkTree	Gets or sets the PDF bookmark tree that will be used with this document. Default value is null (no tree).
	CreateSelfPrintingPdf	Gets or sets a boolean indicating if the output PDF file should be self-printing
	DocumentType	Specifies the type of PDF document that will be produced, including PDF-A.
	EncryptMetadata	Sets or gets a boolean indicating that metadata stream should be encrypted. Default is true.
	Jpeg2000Quality	Gets or sets Jpeg2000 quality value.
	JpegQuality	Gets or sets the JPEG quality used when the image compression is set to Jpeg.
	Linearized	Gets or sets a value indicating whether the PDF document will be saved as linearized.
	Metadata	Gets or sets the metadata information used for this PDF.
	Mode	Gets or sets a value indicating how to compress each page.
	OwnerPassword	Obsolete. Sets or gets an owner password to use for the document. Default value is null (no password).
	PageBorder	Gets or sets the amount of border space around the image in PDF Page Units.
	PageSize	Gets or sets the size of the PDF pages in PDF Page Units. PDF uses an internal resolution of 72dpi, so an 8.5 x 11 inch page would be 612 x 792 pixels.
	PdfVersion	Gets or sets the desired PDF version for the output document. Currently, this will accept 2.0 value and values from 1.0 to 1.7 in increments of 0.1. Other values will be rejected. Defaults to 1.4.
	Permissions	Sets or gets the set of allowable actions for this PDF.
	SelfPrintingShowsPrintOptions	When set to true, self-printing shows the print options dialog.
	SelfPrintingShrinksToFitPage	When set to true, self-printing adjusts the content to fit the page size.
	SizeMode
	SupportedPixelFormats	Returns an array of the legal pixel formats accepted by the PdfEncoder. (Overrides ImageEncoder.SupportedPixelFormats.)
	UseAdvancedImageCompression	Allows the PdfEncoder to use JPEG2000 or JBIG2 image compression for color and black and white documents respectively.
	UseCompressedObjectStreams	Gets or sets a value indicating whether the PDF document contains compressed object streams.
	UseJbig2LossyCompression	Gets or sets a value indicating whether to use Lossy mode in case of Jbig2 compression.
	UserPassword	Obsolete. Sets or gets a user password to use for the document. Default value is null (no password).
	Xmp	Gets or sets a byte array containing XMP data.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetGrayImage
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetOneBitImage
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsPixelFormatSupported	Returns true if the given PixelFormat can be encoded with the derived encoder. (Inherited from ImageEncoder.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnProcessSegment
	OnSetEncoderCompression	Called when the encoder needs to select a compression. (Inherited from MultiFramedImageEncoder.)
	Save(Stream, AtalaImage, ProgressEventHandler)	Saves an image to a PDF file. (Overrides ImageEncoder.Save(Stream, AtalaImage, ProgressEventHandler).)
	Save(Stream, PdfImage, ProgressEventHandler)	Creates a single or multipage page PDF file from the specified PdfImage object.
	Save(Stream, PdfImageCollection, ProgressEventHandler)	Saves one or more images to a PDF file.
	Save(Stream, ImageCollection, ProgressEventHandler)	Saves all of the images in an ImageCollection to a PDF file. (Overrides MultiFramedImageEncoder.Save(Stream, ImageCollection, ProgressEventHandler).)
	Save(Stream, ImageSource, ProgressEventHandler)	Saves all of the images in an ImageSource to a PDF file. Only one Image of the ImageSource is in memory at any one time. (Overrides MultiFramedImageEncoder.Save(Stream, ImageSource, ProgressEventHandler).)
	Save(Stream, AtalaImage, PdfCompressionType, ProgressEventHandler)	Creates a single page PDF file from the specified image and compression.
	SetOneTimePasswords	Sets user and owner passwords and generates one-time keys for saving encrypted PDF document. Keys will be reset after calling Save method.
	ToByteArray(AtalaImage, ProgressEventHandler)	Saves a single image as a PDF to a byte array.
	ToByteArray(ImageCollection, ProgressEventHandler)	Save an ImageCollection as PDF to a byte array.
	ToByteArray(PdfImageCollection, ProgressEventHandler)	Saves a PdfImageCollection as PDF to a byte array.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ProcessSegment	With this event users may control color type of each segment and even set desired color type for the segments found by PdfEncoder during saving PDFs when segmentation algorithm is used to compress PDFs (see Mode).
	SetEncoderCompression	Occurs when the encoder needs to select a compression. (Inherited from MultiFramedImageEncoder.)

Top

Remarks

To use the PdfEncoder, simply pass an instance of the PdfEncoder to the Save(Stream, ImageEncoder) or Save(String, ImageEncoder, ProgressEventHandler) method and it will save all images from the Images Property of the Workspace object into the PDF File. To compose a multipage PDF document from images not in memory all at once, or at a specified compression format, follow the steps in the example above.

DotImage Document Imaging is required for PDF Encode functionality.

Reference

Atalasoft.Imaging.Codec.Pdf Namespace