Document Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Represents a PDF document.
Inheritance Hierarchy
Bytescout.PDFDocument
Namespace:Bytescout.PDF
Assembly: Bytescout.PDF (in Bytescout.PDF.dll) Version: 3.5.1.1204-master
Syntax
The Document type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Document | Creates a new PDF document. |
| Document(Stream) | Creates a new PDF document initialized with the data from a specified stream with PDF data. |
| Document(String) | Creates a new PDF document initialized with the data from the specified existing PDF file. |
| Document(Stream, String) | Creates a new PDF document initialized with the data from a specified stream with PDF data. |
| Document(String, String) | Creates a new PDF document and loads data from specified existing PDF file. |
Properties
| Name | Description | |
|---|---|---|
 | ComHelpers | Set of helping methods for use from COM/ActiveX. |
| Compression | Gets or sets the document compression to use when saving the document. |
| DocumentInfo | Offers access to the document information object where the document's title, subject, keywords, etc. can be set. |
| EmbeddedFiles | Gets the root collection of the embedded files. |
| LicenseInfo | Gets license information. |
| LinkedFieldsChangeFontForAllAutomatically | Force all linked field to use same font flag |
| Metadata | Gets the document metadata. |
| OnAfterPrinting | Gets or sets the action to be performed after printing a document. |
| OnAfterSaving | Gets or sets the action to be performed after saving a document. |
| OnBeforeClosing | Gets or sets the action to be performed before closing a document. |
| OnBeforePrinting | Gets or sets the action to be performed before printing a document. |
| OnBeforeSaving | Gets or set the action to be performed before saving a document. |
| OnOpenDocument | Gets or sets the action to be performed when the document is opened. |
| OptionalContents | Gets the document’s optional content properties. |
| Outlines | Gets the root collection of the outline items. |
| PageLabels | Gets the root collection of the page labels items. |
| PageLayout | Gets or sets the page layout to be used when the document is opened by a PDF viewer application. |
| PageMode | Gets or sets how the document should be displayed when opened by a PDF viewer application. |
| Pages | Gets the document pages collection. |
| Profiles | Comma-separated list of profiles to apply to the Document. Profiles are sets of properties and methods represented as JSON string. Check the source code examples online or installed with the SDK. |
| RegistrationKey | Registration key. |
| RegistrationName | Registration name. |
| RenameMatchingFieldsDuringMerge | Sets whether to rename form controls with matching names during merging with MergeDocuments(Document) methods. |
| Security | Offers access to security features of the PDF document such as encryption and digital signatures. |
| Version | Gets the component version number. |
| ViewerPreferences | Offers access to viewer preferences of this document. |
| Watermarks | Gets the collection of watermarks added to every page of the document. |
Methods
| Name | Description | |
|---|---|---|
| Append | Appends the contents of specified PDF document to the current document. |
| Dispose | Releases all resources used by the Document |
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides ObjectFinalize.) |
| FlattenDocument | Flattens document (replaces all input controls with static text) making PDF forms uneditable. |
| GetDocumentBytes | Gets the bytes of the document. |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| Load(Stream) | Loads document from specified stream. |
| Load(String) | Loads document from specified file. |
| Load(Stream, String) | Loads document from specified stream. |
| Load(String, String) | Loads document from specified file. |
| LoadAndApplyProfiles | Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction. |
| LoadProfiles | Loads profiles from file. |
| LoadProfilesFromString | Loads profiles from JSON string. |
| MergeDocuments(Document) | Merges two documents. |
| MergeDocuments(Document) | Merges multiple documents. |
| MergeDocuments(Document, Document) | Merges three documents. |
| MergeDocuments(Document, Document, Document) | Merges four documents. |
| Save(Stream) | Saves the document to the specified stream. |
| Save(String) | Saves the document to the specified file. |
| SaveRange(Stream, Int32, Int32) | Saves the specified range of pages to the specified stream. |
| SaveRange(String, Int32, Int32) | Saves range of pages to the specified file. |
| SaveText(Stream) | Saves the document as text to the specified stream. |
| SaveText(String) | Saves the document as text to the specified file. |
| Sign(String, String) | Signs document with digital signature. |
| Sign(String, String, RectangleF, String, String, String) | Signs document with digital signature. |
| Sign(String, String, RectangleF, String, String, String, NullableDateTime) | Signs document with digital signature. |
| Sign(String, String, Single, Single, Single, Single, String, String, String) | Signs document with digital signature. |
| Sign(String, String, Single, Single, Single, Single, String, String, String, NullableDateTime) | Signs document with digital signature. |
| specialOverrideAddFontDataFile | Add Font Files to be used as first priority when writing the file |
| specialOverrideSetDebugUseOnlyUseFixedIVForEncrypton | Force regular encrypt for the successful unit-test |
| specialOverrideSetForcedTimestamp | Force writing of specific timestamp to file |
| specialOverrideSetForcedVersionInfo | Force writing of test version info to file |
| ToString | (Inherited from Object.) |
See Also