| Name | Description | |
|---|---|---|
 | PdfDocument | Overloaded. Initializes a new instance of the PdfDocument class. |
PdfDocument Class Members
In This Topic
The following tables list the members exposed by PdfDocument.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | AdditionalActions | Gets or sets an additional-actions defining the actions to be taken in response to various trigger events affecting the document as a whole. |
| Attachments | Gets a collections of file attachments that a PDF consumer uses to enhance the presentation of file attachments stored in the PDF document. |
| AuthorizationResult | Gets a result of last authentication. |
| AutoUpdateInteractiveFormAppearances | Gets or sets a value indicating whether the document must automatically update the interactive field appearances if NeedAppearances is set to true . |
| Bookmarks | Gets or sets the collection of bookmarks of this PDF document. |
| Catalog | Gets the PDF document catalog - root of a document object hierarchy. |
| DecodingSettings | Gets or sets settings for decoding of pages of this PDF document. |
| DocumentInformation | Gets or sets information (author, modification date, etc) about this PDF document. |
| DocumentViewMode | Gets or sets the document view mode (PageMode) that specifies how the document should be displayed when opened. |
| EmbeddedFiles | Gets or sets a dictionary of embedded file specifications. |
| EncryptionSystem | Gets an information about encryption system. |
| Extensions | Gets or sets a extensions dictionary representing information about the PDF extensions that this document contains. |
| FontManager | Gets or sets a font manager of this PDF document. |
| FontProgramsController | Gets or sets FontProgramsControllerBase that allows to access external font programs. |
| Format | Gets the format of this PDF document that specified in the file's header. |
| HasDocumentInformation | Gets a value indicating whether this document has the document information. |
| HasLineariztionInformation | Gets a value indicating whether PDF file has linearization information. |
| InteractiveForm | Gets or sets information about contents and properties of a document interactive form. |
| IsChanged | Gets a value indicating whether PDF document is changed. |
| IsDisposed | Gets a value indicating whether this PDF document is disposed. |
| IsEncrypted | Gets a value indicating whether the PDF document is encrypted. |
| IsSavingRequired | Gets or sets a value indicating whether the PDF document requires saving. |
| IsWaitingForSingning | Gets a value indicating whether PDF document is waiting for singning (has not imlemented digital signatures). |
| JavaScripts | Gets or sets a dictionary that maps names to the document-level JavaScript actions. |
| MarkedInformation | Gets or sets information about the document's usage of Tagged PDF conventions. |
| Metadata | Gets or sets metadata associated with this PDF document. |
| 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. |
| OptionalContentConfiguration | Gets or sets a configuration of current optional content. |
| OptionalContentProperties | Gets or sets the properties of document optional content. |
| PageLabels | Gets or sets an information about page labeling. |
| Pages | Gets the collection of pages of this PDF document. |
| RenderingSettings | Gets or sets settings for rendering of pages of this PDF document. |
| Revisions | Gets the document revisions. |
| RuntimeMessages | Gets a collection of runtime messages, which occured during loading of this PDF document or rendering of PDF pages in current thread. |
| SourceStream | Gets the source stream of this PDF document. |
| SourceStreamSyncObject | Gets the object that is used for synchronized access to the SourceStream . |
| SpecificationVersion | Gets or sets the version of the PDF specification to which the document conforms (for example, 1.4) if later than the version specified in the file's header ( Format ). |
| StreamLength | Gets the length of the source (file or stream) of this PDF document. |
| StructureTree | Gets or sets the document's structure tree root dictionary. |
| ViewerPageLayout | Gets or sets the mode that specifies the page layout to be used when the document is opened. |
| ViewerPreferences | Gets or sets a viewer preferences that specify the way the document is to be displayed on the screen. |
Public Methods
| Name | Description | |
|---|---|---|
 | AddDocument | Overloaded. Adds pages from specified PDF document to the current PDF document, also adds bookmark tree of specified PDF document to the bookmark in current PDF document. |
| AddRuntimeMessage | Adds the runtime message to the RuntimeMessages property. |
| Authenticate | Performs authentication using specified password. |
| AuthenticateAsOwner | Performs authentication as owner using specified password. |
| AuthenticateAsUser | Performs authentication as user using specified password. |
| ClearCache | Clear the resources cache. |
| ClearRuntimeMessages | Clears the list of runtime messages. |
| ConvertDocument | Overloaded. Converts a PDF document to the conformance with the specified format. |
| CreateAttachments | Creates the Attachments (Portfolio). |
| Dispose | Releases all resources used by this PdfDocument . |
| GetAllRuntimeMessages | Returns the array of runtime messages, which occured during loading of this PDF document or rendering of PDF pages in any thread. |
| GetDocumentConformance | Returns the PDF document conformance from the PDF document metadata. |
| GetFonts | Overloaded. Returns a collection of fonts of this PDF document. |
| GetImages | Returns a collection of image-resources of this PDF document. |
| GetMultipleUsedXObjectResources | Returns XObject resources (images, forms), which are used multiple times in content streams. |
| GetResources | Returns a collection of resources of this PDF document. |
| GetSignatureInformation | Returns all digital signatures of PDF document. |
| Optimize | Overloaded. Optimizes the PDF document and converts PDF document to the specified format with specified encryption settings. |
| Pack | Overloaded. Packs and saves PDF document to specified stream in specified format and switches to the specified stream. |
| RemoveAttachments | Removes the Attachments (Portfolio). |
| RemoveDuplicateResources | Overloaded. Removes the duplicate resources ( PdfResource , PdfFont or PdfColorSpace ) in PDF document. |
| RemoveStructureTree | Removes a structure tree from this PDF document. |
| RemoveUnusedNamedResources | Overloaded. Removes the unused named resources. |
| RemoveUnusedNames | Analyzes the name dictionary of PDF document and removes not used names from the name dictionary. |
| RemoveUnusedPages | Searches not used pages in PDF document and removes not used pages from PDF document. Also method removes all references to removed PDF pages. |
| Save | Overloaded. Saves the PDF document to file. |
| SaveChanges | Overloaded. Saves the changes to the source of PDF document. |
| VerifyDocument | Overloaded. Verifies the PDF document to conformance with the specified format. |
Public Events
| Name | Description | |
|---|---|---|
 | DocumentChanged | Occurs when PDF document is changed. i.e. the value of the IsChanged property is changed. |
| IsSavingRequiredChanged | Occurs when IsSavingRequired property value is changed. |
| Progress | Occurs when the PDF file is packing/saving. |
| RuntimeMessageAdded | Occurs when the runtime message is added to the RuntimeMessages property. |
See Also