Click or drag to resize
PDFDocument Class
A class that represents a PDF document
A class that represents a PDF document
A class that represents a PDF document
A class that represents a PDF document
A class that represents a PDF document
A class that represents a PDF document
A class that represents a PDF document
Inheritance Hierarchy
SystemObject
  RasterEdge.Imaging.BasicBaseDocument
    RasterEdge.XDoc.PDFPDFDocument

Namespace: RasterEdge.XDoc.PDF
Assembly: RasterEdge.XDoc.PDF (in RasterEdge.XDoc.PDF.dll) Version: 9.8.7.60526 (9.8.7.60526)
Syntax
public class PDFDocument : BaseDocument

The PDFDocument type exposes the following members.

Constructors
  NameDescription
Public methodPDFDocument(Byte)
Loads PDF document from byte array.
Public methodPDFDocument(Bitmap)
Creates a multi-page PDF document from a sequence of bitmaps.
Public methodPDFDocument(Stream)
Loads PDF document from stream.
Public methodPDFDocument(String)
Loads a PDF document from a local file.
Public methodPDFDocument(BaseImage)
Creates a single page PDF document from a (raster) image.
Public methodPDFDocument(BaseImage)
Creates a multi-page PDF document from a sequence of (raster) images.
Public methodPDFDocument(Bitmap, PDFCompression)
Creates a multi-page PDF document from a sequence of bitmaps with specified compression algorithm.
Public methodPDFDocument(String, String)
Loads a PDF document from a local file with the specified password.
Public methodPDFDocument(BaseImage, PDFCompression)
Creates a multi-page PDF document from a sequence of (raster) images with specified compression algorithm.
Public methodPDFDocument(String, String, String)
Loads a PDF document from a local file with the specified user password or owner password.
Top
Methods
  NameDescription
Public methodAddEmptyPage(Int32)
Adds an empty page to the specified position.
Public methodAddEmptyPage(Int32, PaperSize)
Adds an empty page to the specified position.
Public methodStatic memberAddEmptyPage(String, Int32)
Public methodStatic memberAddEmptyPage(String, Int32, String)
Public methodAddEmptyPages(Int32, Int32)
Adds empty pages to the specified position, with default paper size.
Public methodAddEmptyPages(Int32, Int32, PaperSize)
Adds empty pages to the specified position.
Public methodStatic memberAddEmptyPages(String, Int32, Int32)
Public methodStatic memberAddEmptyPages(String, Int32, Int32, String)
Public methodAddPage
Adds a new page to the end of the document
(Overrides BaseDocumentAddPage(BasePage).)
Public methodAddPages
Public methodStatic memberAddPassword(String, PasswordSetting)
Add a password to a plain PDF file.
Public methodStatic memberAddPassword(Stream, Stream, PasswordSetting)
Add a password to a plain PDF file stream.
Public methodStatic memberAddPassword(String, String, PasswordSetting)
Add a password to a plain PDF file.
Public methodAppendDocument
Public methodBurnAnnotation (Overrides BaseDocumentBurnAnnotation.)
Public methodStatic memberChangePassword(String, String, PasswordSetting)
Public methodStatic memberChangePassword(Stream, Stream, String, PasswordSetting)
Public methodStatic memberChangePassword(String, String, String, PasswordSetting)
Public methodClone (Overrides BaseDocumentClone.)
Public methodStatic memberCombineDocument(Stream, Stream)
Public methodStatic memberCombineDocument(Stream, String)
Public methodStatic memberCombineDocument(String, Stream)
Public methodStatic memberCombineDocument(String, String)
Combine PDF files to a single file.
Public methodStatic memberCombinePages
Combine pages in the PDF file.
Public methodConvertToDocument(DocumentType, Stream)
Converts document to the target file format and saves it into a stream. Throw an exception in condition:
(Overrides BaseDocumentConvertToDocument(DocumentType, Stream).)
Public methodConvertToDocument(DocumentType, String)
Converts document to the target file format and saves it to a file on the local disk.
(Overrides BaseDocumentConvertToDocument(DocumentType, String).)
Public methodConvertToDocument(DocumentType, ImageCompress, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, ImageCompress, Stream).)
Public methodConvertToDocument(DocumentType, ImageCompress, String)
Converts document to the target file format and saves it to a file on the local disk.
(Overrides BaseDocumentConvertToDocument(DocumentType, ImageCompress, String).)
Public methodConvertToDocument(DocumentType, Int32, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, Stream).)
Public methodConvertToDocument(DocumentType, Int32, String) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, String).)
Public methodConvertToDocument(DocumentType, Stream, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, Stream, ImageOutputOption).)
Public methodConvertToDocument(DocumentType, Single, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Single, Stream).)
Public methodConvertToDocument(DocumentType, Single, String)
Converts document to the target file format with with sepcified zoom value and saves it to a file on the local disk.
(Overrides BaseDocumentConvertToDocument(DocumentType, Single, String).)
Public methodConvertToDocument(DocumentType, String, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, String, ImageOutputOption).)
Public methodConvertToHtml (Overrides BaseDocumentConvertToHtml(String, String, RelativeType).)
Public methodConvertToImages(ImageType, Stream)
Converts document to images with specified type, one image per page, and store each image into a stream. Default: zoom value = 1, resolution = 96 dpi.
(Overrides BaseDocumentConvertToImages(ImageType, Stream).)
Public methodConvertToImages(ImageType, ImageOutputOption, Stream) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, Stream).)
Public methodConvertToImages(ImageType, Int32, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Int32, Stream).)
Public methodConvertToImages(ImageType, Single, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Single, Stream).)
Public methodConvertToImages(ImageType, String, String)
Converts document to images with sepcified type, one image per page, and store the image under a local file directory. Default: zoom value = 1, resolution = 96 dpi. File name format: [directory] + [fileName] + page index + [extension]
(Overrides BaseDocumentConvertToImages(ImageType, String, String).)
Public methodConvertToImages(ImageType, ImageOutputOption, String, String) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, String, String).)
Public methodConvertToImages(ImageType, Int32, String, String) (Overrides BaseDocumentConvertToImages(ImageType, Int32, String, String).)
Public methodConvertToImages(ImageType, Single, String, String)
Converts document to images with sepcified type and zoom value, one image per page, and store the image under a local file directory. File name format: [directory] + [fileName] + page index + [extension]
(Overrides BaseDocumentConvertToImages(ImageType, Single, String, String).)
Public methodConvertToVectorImages
Public methodStatic memberCreate(Int32)
Create a PDFDocument with specified number of pages.
Public methodStatic memberCreate(Bitmap, ImageToPDFSetting)
Create a document by a Bitmap object.
Public methodStatic memberCreate(Bitmap, ImageToPDFSetting)
Create a document by a list of Bitmap objects.
Public methodStatic memberCreate(Int32, PaperSize)
Create a PDFDocument with specified number of pages and page size.
Public methodStatic memberCreate(Int32, ListRectangleF)
Create a PDFDocument with specified number of pages and rectangles.
Public methodStatic memberCreate(Int32, Single, Single)
Create a PDFDocument with specified number of pages and page width, height.
Public methodStatic memberCreatePDFFile(String)
Public methodStatic memberCreatePDFFile(String, Int32)
Public methodCropAllPages
Crop all pages in the document by the given rectangle
Public methodStatic memberCropPages
Public methodStatic memberDeleteDocumentPages(String, Int32)
Public methodStatic memberDeleteDocumentPages(String, Int32, Int32)
Public methodStatic memberDeleteDocumentPages(String, Int32, String)
Public methodStatic memberDeleteDocumentPages(String, Int32, Int32, String)
Public methodDeletePage
Deletes an exist page in the document. This method could not be applied to a single-page document.
(Overrides BaseDocumentDeletePage(Int32).)
Public methodDeletePages(Int32)
Public methodDeletePages(Int32, Int32)
Public methodDispose
Releases all resources used by the PDFDocument
(Overrides BaseDocumentDispose.)
Public methodDuplicatePage
Duplicate a PDFPage object from the specified page.
(Overrides BaseDocumentDuplicatePage(Int32).)
Public methodDuplicatePages
Duplicate PDFPage objects.
Public methodStatic memberExportFDFDocument(String, String)
Export a FDF file from a target PDF file.
Public methodStatic memberExportFDFDocument(String, Int32, String)
Export a FDF file from a target PDF file for the specified page.
Public methodStatic memberExportFDFDocument(String, Int32, String)
Export a FDF file from a target PDF file for the specified pages.
Public methodStatic memberExtractDocument(String, Int32)
Public methodStatic memberExtractDocument(String, Int32, String)
Public methodExtractPages(Int32, Stream)
Extracts pages from this document to a PDF file stream.
(Overrides BaseDocumentExtractPages(Int32, Stream).)
Public methodExtractPages(Int32, String)
Extracts pages from this document to create a new PDF file.
(Overrides BaseDocumentExtractPages(Int32, String).)
Public methodStatic memberfullyLoaded
Public methodGetAllFontNameKeys
Public methodGetAllFontNameKeys(Int32)
Public methodGetCharsRectangle
For Internal Use Only
(Overrides BaseDocumentGetCharsRectangle(Int32).)
Public methodGetDescription
Get description. Note: Fail to parse the metadata will not broken to load the document.
Public methodGetDocumentType
Public methodGetFontGlyphWidths
For Internal Use Only
(Overrides BaseDocumentGetFontGlyphWidths(String).)
Public methodGetHyperlink
Get Hyperlink information in a document
(Overrides BaseDocumentGetHyperlink.)
Public methodGetHyperlink(Int32)
Get Hyperlink information in the specified page
Public methodGetMultiDocument
Public methodGetNewPage
For Internal Use Create an empty PDFPage object with document default setting.
(Overrides BaseDocumentGetNewPage.)
Public methodGetOutline
Get outline
(Overrides BaseDocumentGetOutline.)
Public methodGetPage
Get the page by the page index.
(Overrides BaseDocumentGetPage(Int32).)
Public methodGetPageCount
Get page count.
(Overrides BaseDocumentGetPageCount.)
Public methodStatic memberGetPasswordSetting
Public methodStatic memberGetPreviewImage(Byte, Size)
Public methodStatic memberGetPreviewImage(Stream, Size)
Public methodStatic memberGetPreviewImage(String, Size)
Quick to load the first page of the document and render it to specific size.
Public methodStatic memberHasUserPassword
Public methodStatic memberImportFDFDocument
Import a FDF file to a target PDF file and save to a new PDF file.
Public methodInsertPage(Int32)
Same to AddEmptyPage(int pageIndex)
Public methodInsertPage(Int32, PaperSize)
Same to AddEmptyPage(int pageIndex, PaperSize pageSize)
Public methodInsertPage(BasePage, Int32)
Public methodInsertPages
Public methodStatic memberIsEncrypted
Public methodIsPageExist
Public methodIsPageLoaded
Public methodMergeDocument
Public methodMovePage
Move the page from one position to another.
Public methodStatic memberOpen
Public methodStatic memberpageLoaded
Public methodStatic memberpagePreloadComplete
Public methodStatic memberpageRenderStart
Public methodStatic memberParsePageIndexes
Public methodStatic memberRemovePassword(String, String)
Public methodStatic memberRemovePassword(Stream, Stream, String)
Public methodStatic memberRemovePassword(String, String, String)
Public methodReplace(String, String, RESearchOption)
Replace specified word in the pdf document.
Public methodReplace(String, String, RESearchOption, Int32)
Replace specified word in the specified pdf page.
Public methodReplace(String, String, RESearchOption, Int32, Int32)
Replace specified text from specified pdf page from the offset page index.
Public methodStatic memberRotateAllPages(String, Int32)
Public methodStatic memberRotateAllPages(String, Int32, String)
Public methodStatic memberRotatePage(String, Int32, Int32)
Public methodStatic memberRotatePage(String, Int32, Int32, String)
Public methodSave(String)
Output to a file with the specified file path.
(Overrides BaseDocumentSave(String).)
Public methodSave(String, PasswordSetting)
Saves to a PDF file with specified user password string and default owner password string.
Public methodSaveFontToWebFont
Saves all fonts in this document to the specified folder. Do nothing if the folder has been exists.
Public methodSaveToBytes
Output this PDF document to a byte array. Return an empty array if failed.
(Overrides BaseDocumentSaveToBytes.)
Public methodSaveToStream
Output this PDF document to a stream.
(Overrides BaseDocumentSaveToStream(Stream).)
Public methodSearch(String, RESearchOption)
Search specified text from pdf document
Public methodSearch(String, RESearchOption, Int32)
Search specified text from specified pdf page
Public methodSearch(String, RESearchOption, Int32, Int32)
Search specified text from specified pdf page from the offset page index.
Public methodSearchTextAndDelete(String, RESearchOption)
Delete specified text from pdf document.
Public methodSearchTextAndDelete(String, RESearchOption, Int32)
Delete specified text from specified pdf page.
Public methodSearchTextAndDelete(String, RESearchOption, Int32, Int32)
Delete specified text from specified pdf page(from offset to offset + pagecount - 1).
Public methodSearchTextAndHighlight(String, RESearchOption)
Highlight specified text from the pdf document.
Public methodSearchTextAndHighlight(String, RESearchOption, Int32)
Highlight specified text from the specified pdf page.
Public methodSearchTextAndHighlight(String, RESearchOption, Int32, Int32)
Highlight specified text from the specified pdf page(from offset to offser + pagecount -1).
Public methodSetDescription
Set description
Public methodSetOutline
Replace currrent document outline with the specified one.
(Overrides BaseDocumentSetOutline(REOutline).)
Public methodSortPage
Public methodStatic memberSplitDocument(Stream, Int32, Stream)
Public methodStatic memberSplitDocument(Stream, Int32, String)
Public methodStatic memberSplitDocument(Stream, Int32, Stream)
Split an PDF file stream into two or more PDF file streams.
Public methodStatic memberSplitDocument(Stream, Int32, String)
Split an PDF file stream into two or more PDF files.
Public methodStatic memberSplitDocument(String, SplitOptions, SplitOutputOptions)
Split an PDF file by the specified options.
Public methodStatic memberSplitDocument(String, Int32, Stream)
Public methodStatic memberSplitDocument(String, Int32, String)
Public methodStatic memberSplitDocument(String, Int32, Stream)
Split an PDF file into two or more PDF file streams.
Public methodStatic memberSplitDocument(String, Int32, String)
Split an PDF file into two or more PDF files. A valid split index is: 1: in the range from 1 to (page count - 1) 2: no duplicate indexes in the array 3: all indexes in the array should be sorted number of output file paths should be greater than the number of split indexes.
Public methodStatic memberstart
Public methodSwapTwoPages
Public methodUpdatePage(BasePage, Int32)
Public methodUpdatePage(PDFContext, Int32)
Flush all graphics items in a PDFContext to replace a page in the document.
Public methodUpdatePages(BasePage, Int32)
Public methodUpdatePages(ListPDFContext, Int32)
Top
Properties
  NameDescription
Public propertyEnableObjectStream
Enable object stream feature. Default: false
Public propertyIsPasswordInvalid
This flag is used to indicate if this object is created from an encrypted document with valid password.
Top
Events
See Also