 | Pdf |
Represents a PDF document.
Inheritance HierarchyNamespace: Patagames.Pdf.Net
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704
SyntaxThe PdfDocument type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AdditionalActions | Gets or sets the additional-actions defining the actions to be taken in response to various trigger events affecting the document as a whole. |
| Attachments | Gets the collection of attachments found in the PDF document. |
| Author | The name of the person who created the document. |
| AvailabilityProvider | Gets PdfAvailabilityProvider object if document was loaded from availability provider. |
| BaseUri | Gets or sets the document-level information for URI actions. |
| Bookmarks | Gets the collection of bookmarks found in the PDF document. |
| CreationDate | The date and time the document was created, in human-readable form (see Section 3.8.3, “Dates” in PDF Refernce 1.7). |
| Creator | If the document was converted to PDF from another format, the name of the application (for example, Adobe FrameMaker®) that created the original document from which it was converted. |
| FormFill | Gets a form fill environment object. |
| Handle | Gets the Pdfium SDK handle that the document is bound to |
| Info | Gets the document’s information dictionary |
| IsDisposed |
Gets a value indicating whether the object has been disposed of.
Field Valuetrue if the control has been disposed of; otherwise, false. |
| Keywords | Keywords associated with the document. |
| Labels | Gets or sets page labeling ranges. |
| ModificationDate | The date and time the document was most recently modified, in human-readable form (see Section 3.8.3, “Dates” in PDF Refernce 1.7). |
| NamedDestinations | Gets the collection of named destinations found in the PDF document. |
| OCProperties | Gets or sets the properties of optional content groups. |
| OpenAction | Gets or sets a value specifying an action to be performed when the document is opened. |
| OpenDestination | Gets or sets a value specifying a destination to be displayed when the document is opened. |
| OutputIntents | Gets or sets the collection of output intents describing the color characteristics of output devices on which the document might be rendered. |
| Pages | Gets the collection of Pages found in the PDF document. |
| PagesMode | Gets the document's PageMode(How the document should be displayed when opened) |
| Permission | Gets permission flags. Please refer to PdfUserAccessPermission for detailed description. |
| Producer | If the document was converted to PDF from another format, the name of the application (for example, Acrobat Distiller) that converted it to PDF. |
| Root | Gets the root catalog of the PDF document |
| SecurityRevision | Gets the security handler revision number. Please refer to PDF Reference for detailed description. |
| Subject | The subject of the document. |
| Tag | Gets or sets the object that contains data about the document. |
| Title | The document’s title. |
| Trailer | Gets the trailer of the PDF file. |
| Trapped | A name object indicating whether the document has been modified to include trapping information (see Section 10.10.5, “Trapping Support” in PDF Reference 1.7). |
| Version | Gets the file version of the specific PDF document. 14 for 1.4, 15 for 1.5, ... |
Methods| Name | Description | |
|---|---|---|
 | CopyViewerPreferences | Copy the viewer preferences from other PDF document to current. |
 | CreateNew | Create a new PDF document. |
| Dispose | Releases all resources used by the PdfDocument. |
 | Dispose(Boolean) | Releases all resources used by the PdfImageObject. |
| DoDocumentAAction | This method is required for performing the document's additional-action. |
| Finalize |
Finalize object
(Overrides ObjectFinalize) |
| FromHandle | Crreate an instance of PdfDocument class from handle. |
| GenerateMetadata | Generate a metadata stream containing metadata for the document. |
| GetMetaText | Get a text from metadata of the document. |
| GetPageSizeByIndex | Get the size of a page by index. |
| Load(PdfCustomLoader) | Loads the PDF document from the specified custom descriptor. |
| Load(Byte, PdfForms, String) | Open and load a PDF document from a memory. |
| Load(String, PdfForms, String) | Open and load a PDF document from a file. |
| Load(Stream, PdfForms, String, Boolean) | Loads the PDF document from the specified stream. |
| Save(SaveFlags, Int32) | Saves the copy of PDF document in custom way. |
| Save(Stream, SaveFlags, Int32) | Saves a copy of PDF document to the stream |
| Save(String, SaveFlags, Int32) | Saves a copy of PDF document to the specified file name |
| SetPasswordProtection | Protect document with a password. |
Events| Name | Description | |
|---|---|---|
 | WriteBlock | SDK fire this event for transmission of the next data block of PDF document from Save(SaveFlags, Int32) method. |
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also