Click or drag to resize

PdfDocument Class

Represents a PDF document.
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.NetPdfDocument

Namespace:  Patagames.Pdf.Net
Assemblies:   Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.84.2704
  Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.84.2704
Syntax
public class PdfDocument : IDisposable

The PdfDocument type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalActions
Gets or sets the additional-actions defining the actions to be taken in response to various trigger events affecting the document as a whole.
Public propertyAttachments
Gets the collection of attachments found in the PDF document.
Public propertyAuthor
The name of the person who created the document.
Public propertyAvailabilityProvider
Gets PdfAvailabilityProvider object if document was loaded from availability provider.
Public propertyBaseUri
Gets or sets the document-level information for URI actions.
Public propertyBookmarks
Gets the collection of bookmarks found in the PDF document.
Public propertyCreationDate
The date and time the document was created, in human-readable form (see Section 3.8.3, “Dates” in PDF Refernce 1.7).
Public propertyCreator
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.
Public propertyFormFill
Gets a form fill environment object.
Public propertyHandle
Gets the Pdfium SDK handle that the document is bound to
Public propertyInfo
Gets the document’s information dictionary
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.

Field Value

Type: 
true if the control has been disposed of; otherwise, false.
Public propertyKeywords
Keywords associated with the document.
Public propertyLabels
Gets or sets page labeling ranges.
Public propertyModificationDate
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).
Public propertyNamedDestinations
Gets the collection of named destinations found in the PDF document.
Public propertyOCProperties
Gets or sets the properties of optional content groups.
Public propertyOpenAction
Gets or sets a value specifying an action to be performed when the document is opened.
Public propertyOpenDestination
Gets or sets a value specifying a destination to be displayed when the document is opened.
Public propertyPages
Gets the collection of Pages found in the PDF document.
Public propertyPagesMode
Gets the document's PageMode(How the document should be displayed when opened)
Public propertyPermission
Gets permission flags. Please refer to PdfUserAccessPermission for detailed description.
Public propertyProducer
If the document was converted to PDF from another format, the name of the application (for example, Acrobat Distiller) that converted it to PDF.
Public propertyRoot
Gets the root catalog of the PDF document
Public propertySecurityRevision
Gets the security handler revision number. Please refer to PDF Reference for detailed description.
Public propertySubject
The subject of the document.
Public propertyTag
Gets or sets the object that contains data about the document.
Public propertyTitle
The document’s title.
Public propertyTrailer
Gets the trailer of the PDF file.
Public propertyTrapped
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).
Public propertyVersion
Gets the file version of the specific PDF document. 14 for 1.4, 15 for 1.5, ...
Top
Methods
  NameDescription
Public methodCopyViewerPreferences
Copy the viewer preferences from other PDF document to current.
Public methodStatic memberCreateNew
Create a new PDF document.
Public methodDispose
Releases all resources used by the PdfDocument.
Protected methodDispose(Boolean)
Releases all resources used by the PdfImageObject.
Public methodDoDocumentAAction
This method is required for performing the document's additional-action.
Protected methodFinalize
Finalize object
(Overrides ObjectFinalize.)
Public methodStatic memberFromHandle
Crreate an instance of PdfDocument class from handle.
Public methodGetMetaText
Get a text from metadata of the document.
Public methodGetPageSizeByIndex
Get the size of a page by index.
Public methodStatic memberLoad(PdfCustomLoader)
Loads the PDF document from the specified custom descriptor.
Public methodStatic memberLoad(Byte, PdfForms, String)
Open and load a PDF document from a memory.
Public methodStatic memberLoad(String, PdfForms, String)
Open and load a PDF document from a file.
Public methodStatic memberLoad(Stream, PdfForms, String, Boolean)
Loads the PDF document from the specified stream.
Public methodSave(SaveFlags, Int32)
Saves the copy of PDF document in custom way.
Public methodSave(Stream, SaveFlags, Int32)
Saves a copy of PDF document to the stream
Public methodSave(String, SaveFlags, Int32)
Saves a copy of PDF document to the specified file name
Public methodSetPasswordProtection
Protect document with a password.
Top
Events
  NameDescription
Public eventWriteBlock
SDK fire this event for transmission of the next data block of PDF document from Save(SaveFlags, Int32) method.
Top
Thread Safety
Any 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