PdfGeneratedDocument Class

The PdfGeneratedDocument object is designed to create documents using the Pdf Generating Tools.

Inheritance Hierarchy

SystemObject
Atalasoft.PdfDoc.GeneratingPdfGeneratedDocument

Namespace: Atalasoft.PdfDoc.Generating
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class PdfGeneratedDocument : IDisposable

Public Class PdfGeneratedDocument
	Implements IDisposable

The PdfGeneratedDocument type exposes the following members.

Constructors

	Name	Description
	PdfGeneratedDocument	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, Boolean)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, SecureString, SecureString)	Initializes a new instance of the PdfGeneratedDocument class. This overload is designed to open an existing DotPdf generated pdf document for editing/modification.
	PdfGeneratedDocument(String, String, Stream)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class. This overload is designed to open an existing DotPdf generated pdf document for editing/modification.
	PdfGeneratedDocument(Stream, SecureString, SecureString, Boolean, PdfDocumentLoadedProgress)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, SecureString, SecureString, Boolean, PdfDocumentLoadedProgress, RepairOptions)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, SecureString, SecureString, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, SecureString, SecureString, Boolean, PdfDocumentLoadedProgress, Int32)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, RepairOptions)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, Int32)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(Stream, SecureString, SecureString, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32, GlobalResources)	Initializes a new instance of the PdfGeneratedDocument class.
	PdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32, GlobalResources)	Obsolete. Initializes a new instance of the PdfGeneratedDocument class.

Top

Properties

	Name	Description
	AdditionalActions	Gets the list of additional actions that may be performed by a document.
	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.
	AllowSavingOfPreviouslySignedDocuments	Gets or sets a value indicating whether to allow previously signed documents to be saved. Default value is false. If set to false, if DocumentWasSigned is true, calling Save will throw a PdfException. If set to true and DocumentWasSigned is true, calling Save will not throw an exception, but will create an invalid PDF which may still render correctly.
	AutomaticValidateAndRepairBeforeSave	Gets or sets a value indicating whether the document should attempt to automatically repair issues that may generate incorrect PDF.
	BookmarkTree	Gets or sets the bookmark tree.
	DisplayMode	Gets or sets the display mode that will be used for this document.
	DocumentCertification	Gets or sets the information used to certify the document.
	DocumentWasSigned	Gets a value indicating whether the document contained a digital signature when opened.
	EmbedGeneratedContent	Gets or sets a value indicating whether to embed Generated content allowing a PdfGeneratedDocument to be reconstructed from a PDF.
	EncryptMetadata	Gets or sets a value indicating whether to encrypt metadata.
	Form	Gets or sets the form object for the document. By default, this is null.
	GlobalJavaScriptActions	Gets the global java script actions that will be executed when the PDF document is opened. This is initialized to an empty collection.
	Metadata	Gets the document's metadata.
	OwnerPassword	Obsolete. Gets or sets the owner password.
	Pages	Gets the pages of the document.
	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	Gets or sets the permissions.
	RepairOptions	Gets the repair options that will be used for the document.
	Resources	Gets or sets the global resources.
	SelfPrinting	Gets or sets a value indicating whether will self print upon opening.
	UserPassword	Obsolete. Gets or sets the user password.
	ValidationChooser	Gets or sets the validation chooser. This is a delegate that is used if AutomaticValidateAndRepairBeforeSave is true to choose to repair detected problems or not. The delegate will be called for each problem in turn. If the delegate returns true, the problem will be repaired. Remarks If ValidationChooser is set to null, only problems of Serious or less will be repaired. If there are any remaining problems, this will cause a PdfException to be thrown containing all the problems detected. Examples Copy doc.ValidationChooser = PdfGeneratedDocument.MakeValidationSeverityChooser(Severity.Minor);
	ViewerPreferences	Gets or sets the viewer preferences for this PDF document. PdfViewerPreferences control coarse levels of document and page level user interaction such as the reading order of the document and print characteristics.

Top

Methods

	Name	Description
	AddPage	Adds the page to the document, returning the added page. This is a convenience method to streamline the process of adding pages to a document.
	Dispose	Releases all resources used by the PdfGeneratedDocument
	Dispose(Boolean)	Releases the unmanaged resources used by the PdfGeneratedDocument and optionally releases the managed resources
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImportPages	Imports pages and associated resources from PDF stream.
	MakeValidationSeverityChooser	This is a convenience factory that will return a new delegate that will repair all problems that are as severe or less severity than the specified maximum.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Save(Stream)	Saves the document to the specified outStream.
	Save(String)	Saves the document to the specified output file.
	Save(Stream, EventHandlerRenderProgressEventArgs)	Saves the document to the specified outStream.
	Save(String, EventHandlerRenderProgressEventArgs)	Saves the document to the specified output file.
	Save(Stream, PdfSaveOptions, EventHandlerRenderProgressEventArgs)	Saves the Pdf document to the output stream using the provided options.
	Save(String, PdfSaveOptions, EventHandlerRenderProgressEventArgs)	Saves the document to the specified output file.
	Save(String, String, Stream, EventHandlerRenderProgressEventArgs)	Obsolete. Saves the Pdf document to the output stream using the provided passwords.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validates the document and returns a set of possible problems.

Top

Examples

//Saves a Pdf document with a blank page PdfGeneratedDocument doc = new PdfGeneratedDocument(); doc.Pages.Add(PdfDefaultPages.Letter); doc.Save(outputStream);

Reference

Atalasoft.PdfDoc.Generating Namespace