Click or drag to resize

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.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class PdfGeneratedDocument : IDisposable

The PdfGeneratedDocument type exposes the following members.

Constructors
  NameDescription
Public methodPdfGeneratedDocument
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(Stream)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(Stream, Boolean)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(String, String, Stream)
Initializes a new instance of the PdfGeneratedDocument class. This overload is designed to open an existing DotPdf generated pdf document for editing/modification.
Public methodPdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, RepairOptions)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, Int32)
Initializes a new instance of the PdfGeneratedDocument class.
Public methodPdfGeneratedDocument(String, String, Stream, Boolean, PdfDocumentLoadedProgress, IEnumerableInt32, GlobalResources)
Initializes a new instance of the PdfGeneratedDocument class.
Top
Properties
  NameDescription
Public propertyAdditionalActions
Gets the list of additional actions that may be performed by a document.
Public propertyAdjustPdfVersionAsNeeded
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.
Public propertyAllowSavingOfPreviouslySignedDocuments
Gets or sets a value indicating whether to allow previously signed documents to be signed. 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.
Public propertyAutomaticValidateAndRepairBeforeSave
Gets or sets a value indicating whether the document should attempt to automatically repair issues that may generate incorrect PDF.
Public propertyBookmarkTree
Gets or sets the bookmark tree.
Public propertyDisplayMode
Gets or sets the display mode that will be used for this document.
Public propertyDocumentCertification
Gets or sets the information used to certify the document.
Public propertyDocumentWasSigned
Gets a value indicating whether the document contained a digital signature when opened.
Public propertyEmbedGeneratedContent
Gets or sets a value indicating whether to embed Generated content allowing a PdfGeneratedDocument to be reconstructed from a PDF.
Public propertyEncryptMetadata
Gets or sets a value indicating whether to encrypt metadata.
Public propertyForm
Gets or sets the form object for the document. By default, this is null.
Public propertyCode exampleGlobalJavaScriptActions
Gets the global java script actions that will be executed when the PDF document is opened. This is initialized to an empty collection.
Public propertyMetadata
Gets the document's metadata.
Public propertyOwnerPassword
Gets or sets the owner password.
Public propertyPages
Gets the pages of the document.
Public propertyPdfVersion
Gets or sets the desired PDF version for the output document. Currently, this will accept values from 1.0 to 1.8 in increments of 0.1. Other values will be rejected. Defaults to 1.4.
Public propertyPermissions
Gets or sets the permissions.
Public propertyRepairOptions
Gets the repair options that will be used for the document.
Public propertyResources
Gets or sets the global resources.
Public propertySelfPrinting
Gets or sets a value indicating whether will self print upon opening.
Public propertyUserPassword
Gets or sets the user password.
Public propertyCode exampleValidationChooser
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
doc.ValidationChooser = PdfGeneratedDocument.MakeValidationSeverityChooser(Severity.Minor);
Public propertyViewerPreferences
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
  NameDescription
Public methodCode exampleAddPage
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.
Public methodDispose
Releases all resources used by the PdfGeneratedDocument
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the PdfGeneratedDocument and optionally releases the managed resources
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.)
Public methodCode exampleImportPages
Imports pages and associated resources from PDF stream.
Public methodStatic memberMakeValidationSeverityChooser
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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSave(Stream)
Saves the document to the specified outStream.
Public methodSave(String)
Saves the document to the specified output file.
Public methodSave(Stream, EventHandlerRenderProgressEventArgs)
Saves the document to the specified outStream.
Public methodSave(String, EventHandlerRenderProgressEventArgs)
Saves the document to the specified output file.
Public methodSave(Stream, PdfSaveOptions, EventHandlerRenderProgressEventArgs)
Saves the Pdf document to the output stream using the provided options.
Public methodSave(String, PdfSaveOptions, EventHandlerRenderProgressEventArgs)
Saves the document to the specified output file.
Public methodSave(String, String, Stream, EventHandlerRenderProgressEventArgs) Obsolete.
Saves the Pdf document to the output stream using the provided passwords.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
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);
See Also