Click or drag to resize

PdfDocument Class

PdfDocument is a representation of a PDF document and the pages and other structures contained therein.
Inheritance Hierarchy
SystemObject
  Atalasoft.PdfDocPdfDocument

Namespace:  Atalasoft.PdfDoc
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class PdfDocument

The PdfDocument type exposes the following members.

Constructors
  NameDescription
Public methodPdfDocument
Initializes a new, empty instance of the PdfDocument class.
Public methodPdfDocument(Stream)
Initializes a new instance of the PdfDocument class, populated from the supplied stream.
Public methodPdfDocument(String)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path.
Public methodPdfDocument(String, Stream)
Initializes a new instance of the PdfDocument class, using the supplied stream and decodes it with the supplied password.
Public methodPdfDocument(String, String)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied password.
Public methodPdfDocument(String, String, Stream)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords.
Public methodPdfDocument(String, String, String)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords.
Public methodPdfDocument(String, String, Stream, PdfDocumentLoadedProgress)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords.
Public methodPdfDocument(String, String, String, RepairOptions)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords.
Public methodPdfDocument(String, String, Stream, PdfDocumentLoadedProgress, RepairOptions)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords and repair options.
Public methodPdfDocument(String, String, Stream, PdfDocumentLoadedProgress, RepairOptions, Boolean)
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path and decodes it with the supplied passwords and repair options.
Top
Properties
  NameDescription
Public propertyAllowSavingOfPreviouslySignedDocuments
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.
Public propertyBookmarkTree
Sets or gets the PdfBookmarkTree for this document.
Public propertyDisplayMode
Gets or sets the display mode that will be used for this document.
Public propertyDocumentCertification
Gets or sets the document certification.
Public propertyDocumentWasSigned
Gets a value indicating whether the document contained a digital signature when opened.
Public propertyEncryptMetadata
Sets or gets a boolean indicating that metadata should be encrypted. Default is false.
Public propertyMetadata
Sets or gets the document metadata for the PDF.
Public propertyOwnerPassword
Sets or gets a password to use for the owner password for the document.
Public propertyPages
Gets a collection of objects that represent the pages in a PDF document.
Public propertyPermissions
Sets or gets the set of allowable actions for this PDF.
Public propertyRepairOptions
Gets the repair options that will be used for the document.
Public propertySelfPrintingPdf
Gets or sets a value indicating whether the document generated will automatically print upon opening.
Public propertyUserPassword
Sets or gets a password to use for the user password for the document.
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 methodClose
Closes the PdfDocument's underlying stream, invalidates all pages, and clears the Pages collection.
Public methodStatic memberCombine(Stream, Stream)
Combines one or more streams containing PDF documents into a single stream.
Public methodStatic memberCombine(Stream, String)
Combines one or more paths containing PDF documents into a single stream.
Public methodStatic memberCombine(String, String)
Combines one or more files containing PDF documents into a single file.
Public methodStatic memberCombine(String, Stream, Stream)
Combines one or more streams containing PDF documents into a single stream and encrypts the document with the supplied password.
Public methodStatic memberCombine(String, Stream, String)
Combines one or more paths containing PDF documents into a single stream and encrypts the document with the supplied password.
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 methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberRepair(Stream, Stream, RepairOptions)
Repairs the PDF document in the Stream input, saving the repaired PDF to the Stream output.
Public methodStatic memberRepair(String, String, RepairOptions)
Repairs the PDF document in file intputPath, saving the repaired PDF to the file outputPath.
Public methodStatic memberRepair(String, String, Stream, Stream, RepairOptions)
Repairs the PDF document in the Stream input, saving the repaired PDF to the Stream output.
Public methodStatic memberRepair(String, String, String, String, RepairOptions)
Repairs the PDF document in file intputPath, saving the repaired PDF to the file outputPath.
Public methodSave(Stream)
Saves a PdfDocument into the supplied stream.
Public methodSave(String)
Saves a PdfDocument to a new file.
Public methodSave(Stream, PdfSaveOptions)
Saves a PdfDocument into the supplied stream.
Public methodSave(String, PdfSaveOptions)
Saves a PdfDocument to a new file.
Public methodSave(String, Stream) Obsolete.
Saves a PdfDocument into the supplied stream, encrypting with the supplied password.
Public methodSave(String, String) Obsolete.
Saves a PdfDocument into a new file encrypting with the supplied password.
Public methodSave(String, String, Stream) Obsolete.
Saves a PdfDocument into a stream encrypting with the supplied passwords.
Public methodSave(String, String, String) Obsolete.
Saves a PdfDocument into a new file encrypting with the supplied passwords.
Public methodStatic memberCode exampleSeparate(String, String, Stream, PdfStreamCreator)
Separates a single PDF into multiple files: one file per page.
Public methodStatic memberCode exampleSeparate(String, String, String, String, String, Boolean)
Separates a single PDF into multiple files: one file per page.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also