PdfDocument Class |
Represent pdf document classes.
Inheritance Hierarchy
System
Object
Spire.Pdf PdfDocument
Spire.Pdf PdfDocument
Namespace: Spire.Pdf
Assembly: Spire.Pdf (in Spire.Pdf.dll) Version: 11.3.7.0 (11.3.7.1046)
Syntax
The PdfDocument type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
PdfDocument |
Initializes a new instance of the class.
|
|
|
PdfDocument( Byte ) |
Initializes a new instance of theclass.
|
|
|
PdfDocument(Stream) |
Initializes a new instance of the class.
|
|
|
PdfDocument(String) |
Initializes a new instance of the class.
|
|
|
PdfDocument( Byte , String) |
Initializes a new instance of theclass.
|
|
|
PdfDocument(Stream, String) |
Initializes a new instance.
|
|
|
PdfDocument(String, String) |
Initializes a new instance of the class.
|
Properties
| Name | Description | |
|---|---|---|
|
AfterOpenAction |
Gets or sets the action to execute when the document is opened.
|
|
|
AfterPrintAction |
Gets or sets the action to be performed after the document is printed.
|
|
|
AfterSaveAction |
Gets or sets the jave script action to be performed after the document is saved.
|
|
AIHelper |
helper for call AI.
|
|
|
AllowCreateForm |
Get or Set Allow Create Form.
|
|
|
Attachments |
Gets the collection of document attachments displayed on a PDF page.
|
|
|
BeforeCloseAction |
Gets or sets the action to be performed before the document is closed.
|
|
|
BeforePrintAction |
Gets or sets the action to be performed before the document is printed.
|
|
|
BeforeSaveAction |
Gets or sets the java script action to be performed before the document is saved.
|
|
|
Bookmarks |
Gets the bookmarks.
|
|
|
Collection |
The pdf collections.
|
|
|
ColorSpace |
Gets or sets the color space for page that will be created.
|
|
|
CompressionLevel |
Gets or sets the desired level of stream compression.
|
|
|
Conformance |
Get document PdfConformanceLevel
|
|
|
ConvertOptions |
Set some options when do convert operation.
|
|
|
DocumentInformation |
Gets document's information and properties.
|
|
|
DocumentPieceInfo |
Gets or set the document piece info.
|
|
|
EnableFontCache |
Indicates whether enable font cache.
|
|
|
FileInfo |
Gets or sets the pdf file info.
|
|
|
Form |
Gets the loaded form.
|
|
|
IsEncrypted |
Indicates the document is encrypted or not.
|
|
|
IsPortfolio |
Indicates the document is a PDF Portfolio or not.
|
|
|
JavaScripts |
Gets the additional document's actions.
|
|
|
Layers |
Optional content properties
|
|
|
Metadata |
Get or set the document metadata.
|
|
|
PageLabels |
Page labels.
|
|
|
Pages |
Gets the pages.
|
|
|
PageSettings |
Gets or sets the page setting.
|
|
|
PDFStandard |
Obsolete.
Set,Get Current active pdf object
|
|
|
PrintSettings |
Get the print settings.
|
|
|
Sections |
Gets the section collections of pdf.
|
|
|
Security |
Obsolete.
Gets the security parameters of the document.
|
|
|
SecurityPolicy |
Gets the document's security policy.
|
|
|
Tag |
The tag of object.
|
|
|
Template |
Gets the template of pdf document
|
|
|
UsedFonts |
Gets the fonts which are available in the PDF document.
|
|
|
UseHighQualityImage |
Obsolete.
Indicates whether to use the high qulity image when convert document
|
|
|
UseInvariantCulture |
Obsolete.
Indicates whether use invariant culture mode to convert pdf document.
|
|
|
UsePsDirectlyForConvert | Obsolete. |
|
|
ViewerPreferences |
Gets or sets a viewer preferences object controlling the way the document is to be
presented on the screen or in print.
|
Methods
| Name | Description | |
|---|---|---|
|
|
AppendPage |
Appends a new page to this one.
|
|
|
AppendPage(PdfDocument) |
Appends the specified loaded document to this one.
|
|
|
ClearCustomFonts |
Clear custom fonts.
|
|
|
ClearCustomFontsFolders |
Obsolete.
Clear the located custom font.
|
|
|
Clone |
Creates a new object that is a copy of the current instance.
|
|
|
Close |
Closes the document.
|
|
|
CreateBooklet(String, Single, Single, Boolean) |
Thie method creates a booklet
|
|
|
CreateBooklet(String, Single, Single, Boolean, DrawPageInBookletEventHandler, DrawPageInBookletEventHandler) |
Thie method creates a booklet
|
|
|
Decrypt |
Decrypts the document.
|
|
|
Decrypt(String) |
Decrypts the document.
|
|
|
Dispose |
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
|
|
Dispose(Boolean) |
Releases all resources used.
|
|
|
Encrypt |
Encrypts the document.
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize | (Overrides Object Finalize .) |
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetSignatureContent |
Get pdf document regarding signature.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
HasExtendedRight |
Indicates whether contains extended right.
|
|
|
InsertPage(PdfDocument, PdfPageBase) |
Imports a page.
|
|
|
InsertPage(PdfDocument, Int32) |
Imports a page.
|
|
|
InsertPage(PdfDocument, Int32, Int32) |
Imports a page.
|
|
|
InsertPageRange |
Imports a page range from a loaded document.
|
|
|
IsPasswordProtected |
Whether the file is password protected.
|
|
|
LoadCustomFontFolder |
Load custom font folder.
|
|
|
LoadCustomFonts |
Load custom fonts.
|
|
|
LoadFromBytes( Byte ) |
Initializes a new instance of the class.
|
|
|
LoadFromBytes( Byte , String) |
Initializes a new instance of the class.
|
|
|
LoadFromFile(String) |
Initializes a new instance of the class.
|
|
|
LoadFromFile(String, FileFormat) |
Initializes a new instance of the class.
|
|
|
LoadFromFile(String, String) |
Initializes a new instance of the class.
|
|
|
LoadFromHTML(String, Boolean, PdfPageSettings, PdfHtmlLayoutFormat) |
Obsolete.
Load htmlSourceCode to Pdf
|
|
|
LoadFromHTML(String, Boolean, Boolean, Boolean) |
Obsolete.
Load file from disk file.
|
|
|
LoadFromHTML(String, Boolean, PdfPageSettings, PdfHtmlLayoutFormat, Boolean) |
Obsolete.
Load htmlSourceCode to Pdf
|
|
|
LoadFromHTML(String, Boolean, Boolean, Boolean, PdfPageSettings) |
Obsolete.
Load file from disk file.
|
|
|
LoadFromHTML(String, Boolean, Boolean, Boolean, PdfPageSettings, PdfHtmlLayoutFormat) |
Obsolete.
Load file from disk file.
|
|
|
LoadFromHTML(String, Boolean, Boolean, Boolean, PdfPageSettings, PdfHtmlLayoutFormat, Boolean) |
Obsolete.
Load file from disk file.
|
|
|
LoadFromStream(Stream) |
Initializes a new instance of the class.
|
|
|
LoadFromStream(Stream, String) |
Initializes a new instance.
|
|
|
LoadFromSvg(Stream) |
Load a svg stream.
|
|
|
LoadFromSvg(String) |
Load a svg file.
|
|
|
LoadFromXPS( Byte ) |
Load a xps bytes array.
|
|
|
LoadFromXPS(Stream) |
Load a xps stream.
|
|
|
LoadFromXPS(String) |
Load a xps file.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
Merge |
Merges the specified source documents and return destination document.
***It is recommended to use method "MergeFiles(string[] inputFiles, string outputFile)" or "MergeFiles(stream[] inputFiles, stream[] outputFile)",
which automatically release srcFiles and mergeFils resources after merging.***
|
|
|
MergeFiles( Stream ) |
Merges the PDF documents specified by the Stream.
***It is recommended to use method "MergeFiles(string[] inputFiles, string outputFile)" or "MergeFiles(stream[] inputFiles, stream[] outputFile)",
which automatically release srcFiles and mergeFils resources after merging.***
|
|
|
MergeFiles( String ) |
Merges the PDF documents specified by the paths.
***It is recommended to use method "MergeFiles(string[] inputFiles, string outputFile)" or "MergeFiles(stream[] inputFiles, stream[] outputFile)",
which automatically release srcFiles and mergeFils resources after merging.***
|
|
|
MergeFiles( Stream , Stream) |
Merge the PDF documents.
|
|
|
MergeFiles(String, String) |
Obsolete.
Merges the PDF documents specified by the paths.
|
|
|
MergeFiles( String , String) |
Merge the PDF documents.
|
|
|
Preview |
Print preview.
|
|
|
Print document.
|
|
|
|
Print(PdfPrintSettings) |
Print document.
|
|
|
RegisterProgressNotifier |
Register progress notifier.
Only SaveToFile() and SaveToStream() methods are supported to obtain the progress.
|
|
|
RemoveDocumentJavaScript |
remove document's javaScript
|
|
|
RemoveExtendedRight |
Removes the extended right.
|
|
|
SaveAsImage(Int32) |
Saves PDF document page as image
|
|
|
SaveAsImage(Int32, PdfImageType) |
Saves PDF document page as image
|
|
|
SaveAsImage(Int32, Int32, Int32) |
Saves PDF document page as image,Set image Dpi
|
|
|
SaveAsImage(Int32, PdfImageType, Int32, Int32) |
Saves PDF document page as image,Set PdfImageType and image Dpi.
|
|
|
SaveToFile(String) |
Saves PDF document to file.
|
|
|
SaveToFile(String, FileFormat) |
Saves PDF document to file.
|
|
|
SaveToFile(String, Int32, Int32, FileFormat) |
Saves PDF document to PDF or other Format files.
Current only supports save PDF document to SVG and PDF
|
|
|
SaveToStream(Stream) |
Save the document to the specified stream.
|
|
|
SaveToStream(FileFormat) |
Convert the document to streams with the file format.
|
|
|
SaveToStream(Stream, FileFormat) |
Convert the document to an stream with the file format.
|
|
|
SaveToStream(Int32, Int32, FileFormat) |
Convert the document to streams with the file format.
|
|
|
SetCustomFontsFolders |
Obsolete.
Set the path to the folder where the custom font is located.
|
|
|
Split(String) |
Splits a PDF file to many PDF files, each of them consists of one page from the source file.
|
|
|
Split(String, Int32) |
Splits a PDF file to many PDF files, each of them consists of
one page from the source file.
|
|
|
SprnpsPgH0nUR8K0SSNXCtXNHDX7 |
»ñÈ¡ÄÚ²¿·ÃÎÊʵÀý.
|
|
|
Sprq6dQUdRyjFEAEAuLARDhJ |
ÉèÖÃÄÚ²¿LicensewÐÅÏ¢(doc viewer, office viewer).
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
VerifySignature |
Verify pdf document regarding signature.
|
See Also
