Click or drag to resize
PDFDocument Methods

The PDFDocument type exposes the following members.

Methods
  Name Description
Public method AddEmptyPage(Int32)
Adds an empty page to the specified position.
Public method AddEmptyPage(Int32, PaperSize)
Adds an empty page to the specified position.
Public method Static member AddEmptyPage(String, Int32)
Public method Static member AddEmptyPage(String, Int32, String)
Public method AddEmptyPages(Int32, Int32)
Adds empty pages to the specified position, with default paper size.
Public method AddEmptyPages(Int32, Int32, PaperSize)
Adds empty pages to the specified position.
Public method Static member AddEmptyPages(String, Int32, Int32)
Public method Static member AddEmptyPages(String, Int32, Int32, String)
Public method AddPage
Adds a new page to the end of the document
(Overrides BaseDocumentAddPage(BasePage).)
Public method AddPages
Public method Static member AddPassword(String, PasswordSetting)
Add a password to a plain PDF file.
Public method Static member AddPassword(Stream, Stream, PasswordSetting)
Add a password to a plain PDF file stream.
Public method Static member AddPassword(String, String, PasswordSetting)
Add a password to a plain PDF file.
Public method AppendDocument
Public method BurnAnnotation (Overrides BaseDocumentBurnAnnotation.)
Public method Static member ChangePassword(String, String, PasswordSetting)
Public method Static member ChangePassword(Stream, Stream, String, PasswordSetting)
Public method Static member ChangePassword(String, String, String, PasswordSetting)
Public method Clone (Overrides BaseDocumentClone.)
Public method Static member CombineDocument(Stream, Stream)
Public method Static member CombineDocument(Stream, String)
Public method Static member CombineDocument(String, Stream)
Public method Static member CombineDocument(String, String)
Combine PDF files to a single file.
Public method Static member CombinePages
Combine pages in the PDF file.
Public method ConvertToDocument(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 method ConvertToDocument(DocumentType, String)
Converts document to the target file format and saves it to a file on the local disk.
(Overrides BaseDocumentConvertToDocument(DocumentType, String).)
Public method ConvertToDocument(DocumentType, ImageCompress, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, ImageCompress, Stream).)
Public method ConvertToDocument(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 method ConvertToDocument(DocumentType, Int32, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, Stream).)
Public method ConvertToDocument(DocumentType, Int32, String) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, String).)
Public method ConvertToDocument(DocumentType, Stream, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, Stream, ImageOutputOption).)
Public method ConvertToDocument(DocumentType, Single, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Single, Stream).)
Public method ConvertToDocument(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 method ConvertToDocument(DocumentType, String, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, String, ImageOutputOption).)
Public method ConvertToHtml (Overrides BaseDocumentConvertToHtml(String, String, RelativeType).)
Public method ConvertToImages(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 method ConvertToImages(ImageType, ImageOutputOption, Stream) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, Stream).)
Public method ConvertToImages(ImageType, Int32, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Int32, Stream).)
Public method ConvertToImages(ImageType, Single, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Single, Stream).)
Public method ConvertToImages(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 method ConvertToImages(ImageType, ImageOutputOption, String, String) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, String, String).)
Public method ConvertToImages(ImageType, Int32, String, String) (Overrides BaseDocumentConvertToImages(ImageType, Int32, String, String).)
Public method ConvertToImages(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 method ConvertToVectorImages
Public method Static member Create(Int32)
Create a PDFDocument with specified number of pages.
Public method Static member Create(Bitmap, ImageToPDFSetting)
Create a document by a Bitmap object.
Public method Static member Create(Bitmap, ImageToPDFSetting)
Create a document by a list of Bitmap objects.
Public method Static member Create(Int32, PaperSize)
Create a PDFDocument with specified number of pages and page size.
Public method Static member Create(Int32, ListRectangleF)
Create a PDFDocument with specified number of pages and rectangles.
Public method Static member Create(Int32, Single, Single)
Create a PDFDocument with specified number of pages and page width, height.
Public method Static member CreatePDFFile(String)
Public method Static member CreatePDFFile(String, Int32)
Public method CropAllPages
Crop all pages in the document by the given rectangle
Public method Static member CropPages
Public method Static member DeleteDocumentPages(String, Int32)
Public method Static member DeleteDocumentPages(String, Int32, Int32)
Public method Static member DeleteDocumentPages(String, Int32, String)
Public method Static member DeleteDocumentPages(String, Int32, Int32, String)
Public method DeletePage
Deletes an exist page in the document. This method could not be applied to a single-page document.
(Overrides BaseDocumentDeletePage(Int32).)
Public method DeletePages(Int32)
Public method DeletePages(Int32, Int32)
Public method Dispose (Overrides BaseDocumentDispose.)
Public method DuplicatePage
Duplicate a PDFPage object from the specified page.
(Overrides BaseDocumentDuplicatePage(Int32).)
Public method DuplicatePages
Duplicate PDFPage objects.
Public method Static member ExportFDFDocument(String, String)
Export a FDF file from a target PDF file.
Public method Static member ExportFDFDocument(String, Int32, String)
Export a FDF file from a target PDF file for the specified page.
Public method Static member ExportFDFDocument(String, Int32, String)
Export a FDF file from a target PDF file for the specified pages.
Public method Static member ExtractDocument(String, Int32)
Public method Static member ExtractDocument(String, Int32, String)
Public method ExtractPages(Int32, Stream)
Extracts pages from this document to a PDF file stream.
(Overrides BaseDocumentExtractPages(Int32, Stream).)
Public method ExtractPages(Int32, String)
Extracts pages from this document to create a new PDF file.
(Overrides BaseDocumentExtractPages(Int32, String).)
Public method Static member fullyLoaded
Public method GetAllFontNameKeys
Public method GetAllFontNameKeys(Int32)
Public method GetCharsRectangle
For Internal Use Only
(Overrides BaseDocumentGetCharsRectangle(Int32).)
Public method GetDescription
Get description. Note: Fail to parse the metadata will not broken to load the document.
Public method GetDocumentType
Public method GetFontGlyphWidths
For Internal Use Only
(Overrides BaseDocumentGetFontGlyphWidths(String).)
Public method GetHyperlink
Get Hyperlink information in a document
(Overrides BaseDocumentGetHyperlink.)
Public method GetHyperlink(Int32)
Get Hyperlink information in the specified page
Public method GetMultiDocument
Public method GetNewPage
For Internal Use Create an empty PDFPage object with document default setting.
(Overrides BaseDocumentGetNewPage.)
Public method GetOutline
Get outline
(Overrides BaseDocumentGetOutline.)
Public method GetPage
Get the page by the page index.
(Overrides BaseDocumentGetPage(Int32).)
Public method GetPageCount
Get page count.
(Overrides BaseDocumentGetPageCount.)
Public method Static member GetPasswordSetting
Public method Static member GetPreviewImage(Byte, Size)
Public method Static member GetPreviewImage(Stream, Size)
Public method Static member GetPreviewImage(String, Size)
Quick to load the first page of the document and render it to specific size.
Public method Static member HasUserPassword
Public method Static member ImportFDFDocument
Import a FDF file to a target PDF file and save to a new PDF file.
Public method InsertPage(Int32)
Same to AddEmptyPage(int pageIndex)
Public method InsertPage(Int32, PaperSize)
Same to AddEmptyPage(int pageIndex, PaperSize pageSize)
Public method InsertPage(BasePage, Int32)
Public method InsertPages
Public method Static member IsEncrypted
Public method IsPageExist
Public method IsPageLoaded
Public method MergeDocument
Public method MovePage
Move the page from one position to another.
Public method Static member Open
Public method Static member pageLoaded
Public method Static member pagePreloadComplete
Public method Static member pageRenderStart
Public method Static member ParsePageIndexes
Public method Static member RemovePassword(String, String)
Public method Static member RemovePassword(Stream, Stream, String)
Public method Static member RemovePassword(String, String, String)
Public method Replace(String, String, RESearchOption)
Replace specified word in the pdf document.
Public method Replace(String, String, RESearchOption, Int32)
Replace specified word in the specified pdf page.
Public method Replace(String, String, RESearchOption, Int32, Int32)
Replace specified text from specified pdf page from the offset page index.
Public method Static member RotateAllPages(String, Int32)
Public method Static member RotateAllPages(String, Int32, String)
Public method Static member RotatePage(String, Int32, Int32)
Public method Static member RotatePage(String, Int32, Int32, String)
Public method Save(String)
Output to a file with the specified file path.
(Overrides BaseDocumentSave(String).)
Public method Save(String, PasswordSetting)
Saves to a PDF file with specified user password string and default owner password string.
Public method SaveFontToWebFont
Saves all fonts in this document to the specified folder. Do nothing if the folder has been exists.
Public method SaveToBytes
Output this PDF document to a byte array. Return an empty array if failed.
(Overrides BaseDocumentSaveToBytes.)
Public method SaveToStream
Output this PDF document to a stream.
(Overrides BaseDocumentSaveToStream(Stream).)
Public method Search(String, RESearchOption)
Search specified text from pdf document
Public method Search(String, RESearchOption, Int32)
Search specified text from specified pdf page
Public method Search(String, RESearchOption, Int32, Int32)
Search specified text from specified pdf page from the offset page index.
Public method SearchTextAndDelete(String, RESearchOption)
Delete specified text from pdf document.
Public method SearchTextAndDelete(String, RESearchOption, Int32)
Delete specified text from specified pdf page.
Public method SearchTextAndDelete(String, RESearchOption, Int32, Int32)
Delete specified text from specified pdf page(from offset to offset + pagecount - 1).
Public method SearchTextAndHighlight(String, RESearchOption)
Highlight specified text from the pdf document.
Public method SearchTextAndHighlight(String, RESearchOption, Int32)
Highlight specified text from the specified pdf page.
Public method SearchTextAndHighlight(String, RESearchOption, Int32, Int32)
Highlight specified text from the specified pdf page(from offset to offser + pagecount -1).
Public method SetDescription
Set description
Public method SetOutline
Replace currrent document outline with the specified one.
(Overrides BaseDocumentSetOutline(REOutline).)
Public method SortPage
Public method Static member SplitDocument(Stream, Int32, Stream)
Public method Static member SplitDocument(Stream, Int32, String)
Public method Static member SplitDocument(Stream, Int32, Stream)
Split an PDF file stream into two or more PDF file streams.
Public method Static member SplitDocument(Stream, Int32, String)
Split an PDF file stream into two or more PDF files.
Public method Static member SplitDocument(String, SplitOptions, SplitOutputOptions)
Split an PDF file by the specified options.
Public method Static member SplitDocument(String, Int32, Stream)
Public method Static member SplitDocument(String, Int32, String)
Public method Static member SplitDocument(String, Int32, Stream)
Split an PDF file into two or more PDF file streams.
Public method Static member SplitDocument(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 method Static member start
Public method SwapTwoPages
Public method UpdatePage(BasePage, Int32)
Public method UpdatePage(PDFContext, Int32)
Flush all graphics items in a PDFContext to replace a page in the document.
Public method UpdatePages(BasePage, Int32)
Public method UpdatePages(ListPDFContext, Int32)
Top
See Also