IDocument

public interface IDocument extends com.aspose.ms.System.IDisposable, Closeable

interface representing PDF document

Methods

Method	Description
afterImport	Enumerate all registered annotations and call AfterImport for each of them.
bindXml	Bind xml to document
bindXml	Bind xml to document
bindXml	Bind xml/xsl to document
changePasswords	Changes document passwords.
check	Validates document.
close	Closes all resources used by this document.
convert	Convert document to searchable document.
convert	Convert document to searchable document and skip errors of hochr that can not be converted.
convert	Convert document and save errors into the specified file.
convert	Convert document and save errors into the specified file.
convert	Convert document and save errors into the specified file. This is allowing to show/hide searchable text on page. Default value is FALSE. This is allowing to get original image from pdf. Default value is FALSE.
convert	Convert document and save errors into the specified file. This is allowing to show/hide searchable text on page. Default value is FALSE. This is allowing to get original image from pdf. Default value is FALSE.
convert
convert	Convert document using specified conversion options
convert	Convert document and save errors into the specified file.
convert	Convert document and save errors into the specified file.
convertInternal	Internal method
convertWithFlatten	Convert document to searchable document and skip errors of hochr that can not be converted.
convertWithSkippingErrors	Convert document to searchable document and skip errors of hochr that can not be converted.
decrypt	Decrypts the document.
dispose	Deprecated.
encrypt	Encrypts the document.
encrypt	Encrypts the document.
encrypt	Encrypts the document.
exportAnnotationsToXfdf	Exports all document annotations to XFDF file
flatten	Removes all fields (and annotations) from the document and place their values instead.
flatten	Removes all fields from the document and place their values instead.
flattenTransparency	Replaces transparent content with non-transparent raster and vector graphics.
freeMemory	Clears memory
getActions	Gets document actions.
getBackground	Gets the background color of the document.
getCatalogValue	Returns item value from catalog dictionary.
getCollection	Gets collection of document.
getCryptoAlgorithm	Gets security settings if document is encrypted.
getCustomSecurityHandler	Gets a custom security handler.
getDefaultCopier	Returns copier used for coping pages to this document.
getDestinations	Gets the collection of destinations.
getDirection	Gets reading order of text: L2R (left to right) or R2L (right to left).
getDuplex	Gets or sets print duplex mode handling option to use when printing the file from the print dialog.
getEmbeddedFiles	Gets collection of files embedded to document.
getEmbedStandardFonts	Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true.
getEnableSignatureSanitization	Gets or sets flag to manage signature fields sanitization.
getEngineDoc	Instance of IPdfDocument used to access to internal document structure.
getFileName	Name of the PDF file that caused this document
getForm	Gets Acro Form of the document.
getId	Gets the ID.
getIgnoreCorruptedObjects	Gets or sets flag of ignoring errors in source files.
getInfo	Gets document info.
getLogicalStructure	Gets logical structure of the document.
getMetadata	Document metadata.
getMetadataStream	Returns raw metadata stream
getNamedDestinations	Collection of Named Destination in the document.
getNonFullScreenPageMode	Gets page mode, specifying how to display the document on exiting full-screen mode.
getObjectById	Gets a object with specified ID in the document.
getOpenAction	Gets action performed at document opening.
getOptimizeSize	Gets optimization flag.
getOutlines	Gets document outlines.
getPageInfo	Gets the page info.(for generator only, not filled in when reading document)
getPageLabels	Gets page labels in the document.
getPageLayout	Gets page layout which shall be used when the document is opened.
getPageMode	Gets page mode, specifying how document should be displayed when opened.
getPages	Gets collection of document pages.
getPdfFormat
getPermissions	Gets permissions of the document.
getPrintScaling	Gets print scaling handling option to use when printing the file from the print dialog.
getTaggedContent	Gets access to TaggedPdf content.
getVersion	Gets a version of Pdf from Pdf file header.
getXmpMetadata	Get XMP metadata from document.
importAnnotationsFromXfdf	Imports annotations from XFDF file to document.
isAbsentFontTryToSubstitute	Notification about missing fonts when processing documents
isCenterWindow	Gets flag specifying whether position of the document’s window will be centerd on the screen.
isDisableFontLicenseVerifications	Many operations with font can’t be executed if these operations are prohibited by license of this font.
isDisplayDocTitle	Gets flag specifying whether document’s window title bar should display document title.
isEncrypted	Gets encrypted status of the document.
isFitWindow	Gets flag specifying whether document window must be resized to fit the first displayed page.
isHideMenubar	Gets flag specifying whether menu bar should be hidden when document is active.
isHideToolBar	Gets flag specifying whether toolbar should be hidden when document is active.
isHideWindowUI	Gets or sets flag specifying whether user interface elements should be hidden when document is active.
isLinearized	Gets or sets a value indicating whether document is linearized.
isManualDisposeEnabled	By default method save close internal streams and release memory resources. We can do some operations and continue work with the document after method save if this ManualDispose parameter is enabled.
isPdfaCompliant	Gets the is document pdf/a compliant.
isPdfUaCompliant	Gets the is document pdfua compliant.
isPickTrayByPdfSize	Gets a flag specifying whether the PDF page size shall be used to select the input paper tray.
isXrefGapsAllowed	Gets or sets the is document pdfa compliant.
optimize	Linearize document in order to - open the first page as quickly as possible; - display next page or follow by link to the next page as quickly as possible; - display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first); - permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.
optimizeResources	Optimize resources in the document: 1.
optimizeResources	Optimize resources in the document according to defined optimization strategy.
pageNodesToBalancedTree	Organizes page tree nodes in a document into a balanced tree.
pageNodesToBalancedTree	Organizes page tree nodes in a document into a balanced tree.
processParagraphs	Stores document into stream.
removeMetadata	Removes metadata from the document.
removePdfaCompliance	Remove pdfa compliance from the document
removePdfUaCompliance	Remove pdfUa compliance from the document
repair	Repairs broken document.
resumeUpdate	resumeUpdate
save	Save document incrementally (i.e.
save	Stores document into stream.
save	Save document
save	Saves the document with a new name setting its save options.
save	Saves document into the specified file.
save	Saves the document with a new name setting its save options.
saveIncrementally	Saves incrementally the PDF Document to the specified stream.
saveIncrementally	Saves incrementally the PDF Document to the specified stream.
saveIncrementally	Saves incrementally the PDF Document to the specified stream.
saveXml	Save document to XML.
sendTo	Sends the certain pages of the document to the document device for processing.
sendTo	Sends the whole document to the document device for processing.
sendTo	Sends the whole document to the document device for processing.
sendTo	Sends the whole document to the document device for processing.
setAbsentFontTryToSubstitute	Setting flag for set program determined font in case of absence font.
setBackground	Sets the background color of the document.
setCenterWindow	Sets flag specifying whether position of the document’s window will be centerd on the screen.
setCollection	Sets collection of document.
setConvertMetadataAndCatalogOnly	Gets convert parameter for pdf/ua converter (Convert only Metadata and Document Catalog if set true)
setDirection	Sets reading order of text: L2R (left to right) or R2L (right to left).
setDisableFontLicenseVerifications	Many operations with font can’t be executed if these operations are prohibited by license of this font.
setDisplayDocTitle	Sets flag specifying whether document’s window title bar should display document title.
setDuplex	Gets or sets print duplex mode handling option to use when printing the file from the print dialog.
setEmbedStandardFonts	Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true.
setEnableSignatureSanitization	Gets or sets flag to manage signature fields sanitization.
setFitWindow	Sets flag specifying whether document window must be resized to fit the first displayed page.
setHideMenubar	Sets flag specifying whether menu bar should be hidden when document is active.
setHideToolBar	Set flag specifying whether toolbar should be hidden when document is active.
setHideWindowUI	Sets flag specifying whether user interface elements should be hidden when document is active.
setIgnoreCorruptedObjects
setLinearized	Sets a value indicating whether document is linearized.
setManualDisposeEnabled	By default method save closes internal streams and release memory resources. We can do some operations and continue work with the document after method save is called if this ManualDispose parameter is enabled. But it is strongly recommended to call the dispose method when the Document instance is no longer needed.
setNonFullScreenPageMode	Sets page mode, specifying how to display the document on exiting full-screen mode.
setOpenAction	Sets action performed at document opening.
setOptimizeSize	Sets optimization flag.
setPageInfo	Sets the page info.(for generator only, not filled in when reading document)
setPageLayout	Sets page layout which shall be used when the document is opened.
setPageMode	Sets page mode, specifying how document should be displayed when opened.
setPickTrayByPdfSize	Sets a flag specifying whether the PDF page size shall be used to select the input paper tray.
setPrintScaling	Sets print scaling handling option to use when printing the file from the print dialog.
setTitle	Set Title for Pdf Document
setXmpMetadata	Set XMP metadata of document.
setXrefGapsAllowed	Gets or sets the is document pdfa compliant.
suppressUpdate	suppressUpdate
updatePages	updatePages
validate	Validate document into the specified file.
validate	Validate document into the specified file.

afterImport

void afterImport()

Enumerate all registered annotations and call AfterImport for each of them.

bindXml

Bind xml to document

bindXml

Bind xml to document

bindXml

Bind xml/xsl to document

changePasswords

Changes document passwords.

check

boolean check(boolean doRepair)

Validates document.

Parameters:

Parameter	Type	Description
doRepair		If true found issues will be repaired.

Returns: boolean value

close

void close()

Closes all resources used by this document.

convert

Convert document to searchable document.