CPDFDocument Methods |
The CPDFDocument type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddBates | |
| AddBookmark |
Adds bookmark
|
| AddHeaderFooter | |
| ApplyRedaction |
Applies redaction annotations in current documentation.
|
| BookmarkForPageIndex |
Returns the bookmark at the specified index.
Indexes are zero based. This method will return null if index is out of bounds.
|
| CheckOwnerPassword | |
| CompressFile_Cancel |
Cancel compression.
|
| CompressFile_Init |
Compression initialization.
|
| CompressFile_Start |
Start compressing the document.
|
 | CreateDocument |
Initializes a CPDFDocument object with new PDF.
|
| Decrypt |
Decrypts document.
|
| DeleteBates | |
| DeleteHeaderFooter | |
| DeleteWatermarks |
Removes all watermarks in the document.
|
| EditBookmark |
Edits bookmark title at the specified page index.
|
| Encrypt |
Encrypts document.
|
| ExchangePage |
Exchanges one page with another.
This method will return false if either index value is out of bounds.
|
| ExportAnnotationToXFDFPath |
Exports annotations to XFDF document.
|
| ExportWidgetToXFDFPath | |
| ExtractImage |
Exports all the images on the page.
|
| GetBackground |
Gets the document’s background.
|
| GetBates |
Gets the document’s bates.
|
| GetBookmarkList |
Gets bookmark list of document.
|
| GetEncryptAlgorithm |
Gets the algorithm of document encryption.
|
| GetHeaderFooter |
Gets the document’s header & footer.
|
| GetInfo |
Gets document information.
|
| GetOutlineList |
Gets outline list of document.
|
| GetOutlineRoot |
Gets outline root of document.
|
| GetPageSize |
Gets page size
|
| GetPDFType |
Gets PDF/A conformance levels.
|
| GetPermissionsInfo |
Gets permission information of document.
|
| GetSignatureList |
Get signature list
|
| ImportAnnotationFromXFDFPath |
Imports annotations from XFDF document.
|
| ImportPages |
Imports page(s) from another document at the end of the document.
|
| ImportPagesAtIndex |
Imports page(s) from another document at the specified index point.
|
| ImportWidgetFromXFDFPath | |
| InitWatermark |
Creates watermark.
|
| InitWithBytes | |
| InitWithFilePath |
Initializes a CPDFDocument object with the contents at the specified URL.
|
| InitWithStream | |
| InitWithUrl | |
| InsertPage(Int32, Single, Single, Byte) | |
| InsertPage(Int32, Single, Single, String) |
Inserts a blank page with image at the specified index point.
Indexes are zero based. The index must lie within bounds, or be equal to the length of bounds.
|
| IsImageDoc |
Whether the document is a scan document.
|
| IsValid |
Whether the object is valid.
|
| MovePage |
Moves one page to another.
This method will return false if either index value is out of bounds.
|
| PageAtIndex |
Returns a CPDFPage object representing the page at index.
Indexes are zero based. This method will return null if index is out of bounds.
|
| PdfToImage |
Converts the specified page(s) to image.
|
| PdfToText |
Converts the specified page(s) to text.
|
| Release |
Releases resource of the object.
|
| ReleaseOutlineList |
Releases resources of the object.
|
| ReleasePages |
Releases resources of the specified page or release resources of all page objects if pageIndex is -1
|
| RemoveBookmark |
Removes the bookmark at the specified index.
|
| RemovePages |
Remove page(s).
|
| RemoveSignature |
Removes a signature from the PDF document.
|
| RotatePage |
Rotates page at the specified index number.
|
| SetInfo |
Sets document information.
|
| UnlockWithPassword |
Attempts to unlock an encrypted document.
If the password is correct, this method returns true, else returns false. Once unlocked, you cannot use this function to relock the document.
|
| WriteFlattenToFilePath |
Writes the document to the specified URL after flattening.
|
| WritePDFAToFilePath |
Converts existing PDF files to PDF/A compliant documents, including PDF/A-1a and PDF/A-1b only.
The conversion option analyzes the content of existing PDF files and performs a sequence of modifications in order to produce a PDF/A compliant document.
Features that are not suitable for long-term archiving(such as encryption, obsolete compression schemes, missing fonts, or device-dependent color) are
replaced with their PDF/A compliant equivalents.Because the conversion process applies only necessary changes to the source file, the information loss is minimal.
|
| WriteSignatureToFilePath |
Writes the signature represented by the specified signature widget to a file.
|
| WriteToBytes | |
| WriteToFilePath |
Writes the document to a location specified by the passed-in URL.
|
| WriteToLoadedPath |
Writes the document to the original path.
|
| WriteToStream |
See Also