Link Search Menu Expand Document

Document Class

Represents a PDF document.
Inheritance Hierarchy
SystemObject
Bytescout.PDFDocument

Namespace:Bytescout.PDF
Assembly: Bytescout.PDF (in Bytescout.PDF.dll) Version: 3.5.1.1204-master
Syntax
public sealed class Document : IDisposable

The Document type exposes the following members.

Constructors
NameDescription
Public methodDocument
Creates a new PDF document.
Public methodDocument(Stream)
Creates a new PDF document initialized with the data from a specified stream with PDF data.
Public methodDocument(String)
Creates a new PDF document initialized with the data from the specified existing PDF file.
Public methodDocument(Stream, String)
Creates a new PDF document initialized with the data from a specified stream with PDF data.
Public methodDocument(String, String)
Creates a new PDF document and loads data from specified existing PDF file.
Top
Properties
NameDescription
Public propertyComHelpers
Set of helping methods for use from COM/ActiveX.
Public propertyCompression
Gets or sets the document compression to use when saving the document.
Public propertyDocumentInfo
Offers access to the document information object where the document's title, subject, keywords, etc. can be set.
Public propertyEmbeddedFiles
Gets the root collection of the embedded files.
Public propertyLicenseInfo
Gets license information.
Public propertyLinkedFieldsChangeFontForAllAutomatically
Force all linked field to use same font flag
Public propertyMetadata
Gets the document metadata.
Public propertyOnAfterPrinting
Gets or sets the action to be performed after printing a document.
Public propertyOnAfterSaving
Gets or sets the action to be performed after saving a document.
Public propertyOnBeforeClosing
Gets or sets the action to be performed before closing a document.
Public propertyOnBeforePrinting
Gets or sets the action to be performed before printing a document.
Public propertyOnBeforeSaving
Gets or set the action to be performed before saving a document.
Public propertyOnOpenDocument
Gets or sets the action to be performed when the document is opened.
Public propertyOptionalContents
Gets the document’s optional content properties.
Public propertyOutlines
Gets the root collection of the outline items.
Public propertyPageLabels
Gets the root collection of the page labels items.
Public propertyPageLayout
Gets or sets the page layout to be used when the document is opened by a PDF viewer application.
Public propertyPageMode
Gets or sets how the document should be displayed when opened by a PDF viewer application.
Public propertyPages
Gets the document pages collection.
Public propertyProfiles
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.
Public propertyRegistrationKey
Registration key.
Public propertyRegistrationName
Registration name.
Public propertyRenameMatchingFieldsDuringMerge
Sets whether to rename form controls with matching names during merging with MergeDocuments(Document) methods.
Public propertySecurity
Offers access to security features of the PDF document such as encryption and digital signatures.
Public propertyVersion
Gets the component version number.
Public propertyViewerPreferences
Offers access to viewer preferences of this document.
Public propertyWatermarks
Gets the collection of watermarks added to every page of the document.
Top
Methods
NameDescription
Public methodAppend
Appends the contents of specified PDF document to the current document.
Public methodDispose
Releases all resources used by the Document
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Public methodFlattenDocument
Flattens document (replaces all input controls with static text) making PDF forms uneditable.
Public methodGetDocumentBytes
Gets the bytes of the document.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoad(Stream)
Loads document from specified stream.
Public methodLoad(String)
Loads document from specified file.
Public methodLoad(Stream, String)
Loads document from specified stream.
Public methodLoad(String, String)
Loads document from specified file.
Public methodLoadAndApplyProfiles
Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
Public methodLoadProfiles
Loads profiles from file.
Public methodLoadProfilesFromString
Loads profiles from JSON string.
Public methodMergeDocuments(Document)
Merges two documents.
Public methodMergeDocuments(Document)
Merges multiple documents.
Public methodMergeDocuments(Document, Document)
Merges three documents.
Public methodMergeDocuments(Document, Document, Document)
Merges four documents.
Public methodSave(Stream)
Saves the document to the specified stream.
Public methodSave(String)
Saves the document to the specified file.
Public methodSaveRange(Stream, Int32, Int32)
Saves the specified range of pages to the specified stream.
Public methodSaveRange(String, Int32, Int32)
Saves range of pages to the specified file.
Public methodSaveText(Stream)
Saves the document as text to the specified stream.
Public methodSaveText(String)
Saves the document as text to the specified file.
Public methodSign(String, String)
Signs document with digital signature.
Public methodSign(String, String, RectangleF, String, String, String)
Signs document with digital signature.
Public methodSign(String, String, RectangleF, String, String, String, NullableDateTime)
Signs document with digital signature.
Public methodSign(String, String, Single, Single, Single, Single, String, String, String)
Signs document with digital signature.
Public methodSign(String, String, Single, Single, Single, Single, String, String, String, NullableDateTime)
Signs document with digital signature.
Public methodspecialOverrideAddFontDataFile
Add Font Files to be used as first priority when writing the file
Public methodspecialOverrideSetDebugUseOnlyUseFixedIVForEncrypton
Force regular encrypt for the successful unit-test
Public methodspecialOverrideSetForcedTimestamp
Force writing of specific timestamp to file
Public methodspecialOverrideSetForcedVersionInfo
Force writing of test version info to file
Public methodToString (Inherited from Object.)
Top
See Also

Reference