PdfDocument Class |
PdfDocument is a representation of a PDF document and the pages and other
structures contained therein.
Inheritance HierarchySystemObject
Atalasoft.PdfDocPdfDocument
Atalasoft.PdfDocPdfDocument
Namespace: Atalasoft.PdfDoc
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe PdfDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfDocument |
Initializes a new, empty instance of the PdfDocument class.
|
| PdfDocument(Stream) |
Initializes a new instance of the PdfDocument class, populated from the supplied stream.
|
| PdfDocument(String) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path.
|
| PdfDocument(Stream, 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.
|
| PdfDocument(Stream, SecureString) |
Initializes a new instance of the PdfDocument class, using the supplied stream and decodes it with
the supplied password.
|
| PdfDocument(String, RepairOptions) | Initializes a new instance of the PdfDocument class |
| PdfDocument(String, Stream) | Obsolete.
Initializes a new instance of the PdfDocument class, using the supplied stream and decodes it with
the supplied password.
|
| PdfDocument(String, SecureString) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied password.
|
| PdfDocument(String, String) | Obsolete.
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied password.
|
| PdfDocument(Stream, SecureString, SecureString) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, SecureString, SecureString) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, String, Stream) | Obsolete.
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, String, String) | Obsolete.
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(Stream, SecureString, SecureString, PdfDocumentLoadedProgress) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, SecureString, SecureString, RepairOptions) |
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, String, Stream, PdfDocumentLoadedProgress) | Obsolete.
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(String, String, String, RepairOptions) | Obsolete.
Initializes a new instance of the PdfDocument class, using the file specified by the supplied path
and decodes it with the supplied passwords.
|
| PdfDocument(Stream, SecureString, SecureString, 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.
|
| PdfDocument(String, String, Stream, PdfDocumentLoadedProgress, RepairOptions) | Obsolete.
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.
|
| PdfDocument(Stream, SecureString, SecureString, 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.
|
| PdfDocument(String, String, Stream, PdfDocumentLoadedProgress, RepairOptions, Boolean) | Obsolete.
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.
|
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| BookmarkTree |
Sets or gets the PdfBookmarkTree for this document.
|
| DisplayMode |
Gets or sets the display mode that will be used for this document.
|
| DocumentCertification |
Gets or sets the document certification.
|
| DocumentWasSigned |
Gets a value indicating whether the document contained a digital signature when opened.
|
| EncryptMetadata |
Sets or gets a boolean indicating that metadata should be encrypted.
Default is false.
|
| IsPdfPortfolio |
Gets a value indicating whether the document contains a PDF Portfolio.
A PDF Portfolio is a feature wherein a PDF document
doesn't necessarily contain any PDF data at all, but instead contains a series of embedded files which
represent the content of the document. Some PDF documents that have a Portfolion include an ersatz page
which is shown for compatibility. The presentation of embedded files is application dependent.
|
| Metadata |
Sets or gets the document metadata for the PDF.
|
| OwnerPassword | Obsolete.
Sets or gets a password to use for the owner password for the document.
|
| Pages |
Gets a collection of objects that represent the pages in a PDF document.
|
| Permissions |
Sets or gets the set of allowable actions for this PDF.
|
| RepairOptions |
Gets the repair options that will be used for the document.
|
| SelfPrintingPdf |
Gets or sets a value indicating whether the document generated will automatically print upon opening.
|
| UserPassword | Obsolete.
Sets or gets a password to use for the user password for the document.
|
| 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.
|
Methods| Name | Description | |
|---|---|---|
| Close |
Closes the PdfDocument's underlying stream, invalidates all pages, and
clears the Pages collection.
|
 | Combine(Stream, Stream) |
Combines one or more streams containing PDF documents into a single stream.
|
| Combine(Stream, String) |
Combines one or more paths containing PDF documents into a single stream.
|
| Combine(String, String) |
Combines one or more files containing PDF documents into a single file.
|
| Combine(Stream, PdfSaveOptions, Stream) |
Combines one or more streams containing PDF documents into a single stream
and encrypts the document with the supplied password.
|
| Combine(Stream, PdfSaveOptions, String) |
Combines one or more paths containing PDF documents into a single stream and
encrypts the document with the supplied password.
|
| Combine(String, Stream, Stream) | Obsolete.
Combines one or more streams containing PDF documents into a single stream
and encrypts the document with the supplied password.
|
| Combine(String, Stream, String) | Obsolete.
Combines one or more paths containing PDF documents into a single stream and
encrypts the document with the supplied password.
|
| 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.) |
| IsPdfACompatible |
Checks the Output Intent color profiles and the PDF/A compatibility level (from metadata) of all source documents.
Note! IsPdfACompatible() method does not check for compliance with the PDF/A standard.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Repair(Stream, Stream, RepairOptions) |
Repairs the PDF document in the Stream input, saving the repaired PDF to the Stream output.
|
| Repair(String, String, RepairOptions) |
Repairs the PDF document in file intputPath, saving the repaired PDF to the file outputPath.
|
| Repair(Stream, Stream, RepairOptions, SecureString, SecureString) |
Repairs the PDF document in the Stream input, saving the repaired PDF to the Stream output.
|
| Repair(String, String, RepairOptions, SecureString, SecureString) |
Repairs the PDF document in file intputPath, saving the repaired PDF to the file outputPath.
|
| Repair(String, String, Stream, Stream, RepairOptions) | Obsolete.
Repairs the PDF document in the Stream input, saving the repaired PDF to the Stream output.
|
| Repair(String, String, String, String, RepairOptions) | Obsolete.
Repairs the PDF document in file intputPath, saving the repaired PDF to the file outputPath.
|
| Save(Stream) |
Saves a PdfDocument into the supplied stream.
|
| Save(String) |
Saves a PdfDocument to a new file.
|
| Save(Stream, PdfSaveOptions) |
Saves a PdfDocument into the supplied stream.
|
| Save(String, PdfSaveOptions) |
Saves a PdfDocument to a new file.
|
| Save(String, Stream) | Obsolete.
Saves a PdfDocument into the supplied stream, encrypting with the supplied
password.
|
| Save(String, String) | Obsolete.
Saves a PdfDocument into a new file encrypting with the supplied password.
|
| Save(String, String, Stream) | Obsolete.
Saves a PdfDocument into a stream encrypting with the supplied passwords.
|
| Save(String, String, String) | Obsolete.
Saves a PdfDocument into a new file encrypting with the supplied passwords.
|
 | Separate(String, String, Stream, PdfStreamCreator) | Obsolete.
Separates a single PDF into multiple files: one file per page.
|
| Separate(Stream, PdfStreamCreator, SecureString, SecureString, RepairOptions, PdfPageSavedHandler) |
Separates a single PDF into multiple files: one file per page.
|
| Separate(String, String, String, String, String, Boolean) | Obsolete.
Separates a single PDF into multiple files: one file per page.
|
| Separate(String, String, String, Boolean, SecureString, SecureString, RepairOptions, PdfPageSavedHandler) |
Separates a single PDF into multiple files: one file per page.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also