| Modifier and Type | Class and Description |
|---|---|
static class |
com.aspose.pdf.ADocument.AbsentFontHandler
Represents class with abstract method that supplied by information about missing fonts when
processing documents.
|
static class |
com.aspose.pdf.ADocument.FontSubstitutionHandler
It represents class with abstract method that usually supplied by information about missing
font while processing documents.
|
static interface |
Document.CallBackGetHocr
The call back procedure for hocr recognize.
|
static class |
Document.OptimizationOptions
Class which describes document optimization algorithm.
|
| Modifier and Type | Field and Description |
|---|---|
com.aspose.pdf.ADocument.AbsentFontHandler |
AbsentFontHandler
Notification about missing fonts while processing documents.
|
PdfEvent<com.aspose.pdf.ADocument.FontSubstitutionHandler> |
FontSubstitution
It occurs when font replaces another font in document.
|
| Constructor and Description |
|---|
Document()
Initializes empty document.
|
Document(InputStream input)
Initialize new Document instance from the
input stream. |
Document(InputStream input,
boolean isManagedStream)
Initialize new Document instance from the
input stream. |
Document(InputStream input,
LoadOptions options)
Opens an existing document from a stream providing necessary converting to get pdf document.
|
Document(InputStream input,
String password)
Initialize new Document instance from the
input stream. |
Document(InputStream input,
String password,
boolean isManagedStream)
Initialize new Document instance from the
input stream. |
Document(com.aspose.ms.System.IO.Stream input)
Initialize new Document instance from the
input stream. |
Document(com.aspose.ms.System.IO.Stream input,
String password) |
Document(String filename)
Just init Document using
filename. |
Document(String filename,
LoadOptions options)
Opens an existing document from a file providing necessary converting to get pdf document.
|
Document(String filename,
String password)
Initializes new instance of the
Document class for working with encrypted document. |
Document(String filename,
String password,
boolean isManagedStream)
Initializes new instance of the
Document class for working with encrypted document. |
| Modifier and Type | Method and Description |
|---|---|
static void |
addLocalFontPath(String path)
Add one more path to fonts.
|
void |
afterImport()
Enumerate all registered annotations and call AfterImport for each of them.
|
void |
bindXml(InputStream xmlStream,
InputStream xslStream)
Bind xml/xsl to document
|
void |
bindXml(String file)
Bind xml to document
|
void |
bindXml(String xmlFile,
String xslFile)
Bind xml/xsl to document
|
void |
changePasswords(String ownerPassword,
String newUserPassword,
String newOwnerPassword)
Changes document passwords.
|
void |
close()
Closes all resources used by this document.
|
boolean |
convert(Document.CallBackGetHocr callback)
Convert document and save errors into the specified file.
|
boolean |
convert(Document.CallBackGetHocr callback,
boolean isTestVisible)
Convert document and save errors into the specified file.
|
boolean |
convert(OutputStream outputLogStream,
int format,
int action)
Convert document and save errors into the specified stream.
|
boolean |
convert(PdfFormatConversionOptions options)
Convert document using specified conversion options
|
boolean |
convert(String outputLogFileName,
int format,
int action)
Convert document and save errors into the specified file.
|
boolean |
convert(String outputLogFileName,
int format,
int action,
int transparencyAction)
Convert document and save errors into the specified file.
|
boolean |
convertInternal(com.aspose.ms.System.IO.Stream outputLogStream,
int format,
int action)
Convert document and save errors into the specified stream.
|
static void |
cutByRestriction(Iterable list) |
void |
decrypt()
Decrypts the document.
|
void |
dispose()
Closes all resources used by this document.
|
void |
encrypt(String userPassword,
String ownerPassword,
DocumentPrivilege privileges,
int cryptoAlgorithm,
boolean usePdf20)
Encrypts the document.
|
void |
encrypt(String userPassword,
String ownerPassword,
int permissions,
int cryptoAlgorithm)
Encrypts the document.
|
void |
encrypt(String userPassword,
String ownerPassword,
int permissions,
int cryptoAlgorithm,
boolean usePdf20)
Encrypts the document.
|
static void |
endOperation() |
void |
exportAnnotationsToXfdf(String fileName)
Exports all document annotations to XFDF file
|
void |
flatten()
Removes all fields from the document and place their values instead.
|
void |
freeMemory()
Clears memory
|
DocumentActionCollection |
getActions()
Gets document actions.
|
boolean |
getAllowReusePageContent()
Allows to merge page contents to optimize docuement size.
|
Color |
getBackground()
Gets the background color of the document.
|
Object |
getCatalogValue(String key)
Returns item value from catalog dictionary.
|
boolean |
getCenterWindow()
Gets flag specifying whether position of the document's window will be centerd on the screen.
|
Collection |
getCollection()
Gets collection of document.
|
int |
getCryptoAlgorithm()
Gets security settings if document is encrypted.
|
Copier |
getDefaultCopier()
Returns copier used for coping pages to this document.
|
DestinationCollection |
getDestinations()
Gets the collection of destinations.
|
int |
getDirection()
Gets reading order of text: L2R (left to right) or R2L (right to left).
|
boolean |
getDisplayDocTitle()
Gets flag specifying whether document's window title bar should display document title.
|
EmbeddedFileCollection |
getEmbeddedFiles()
Gets collection of files embedded to document.
|
boolean |
getEmbedStandardFonts()
Property which declares that document must embed all standard Type1 fonts which has flag
IsEmbedded set into true.
|
boolean |
getEnableObjectUnload()
Get or sets flag which enables document partially be unloaded from memory.
|
com.aspose.pdf.engine.IPdfDocument |
getEngineDoc()
Instance of IPdfDocument used to access to internal document structure.
|
String |
getFileName()
Name of the PDF file that caused this document
|
boolean |
getFitWindow()
Gets flag specifying whether document window must be resized to fit the first displayed page.
|
Form |
getForm()
Gets Acro Form of the document.
|
boolean |
getHideMenubar()
Gets flag specifying whether menu bar should be hidden when document is active.
|
boolean |
getHideToolBar()
Gets flag specifying whether toolbar should be hidden when document is active.
|
boolean |
getHideWindowUI()
Gets flag specifying whether user interface elements should be hidden when document is
active.
|
Id |
getId()
Gets the ID.
|
boolean |
getIgnoreCorruptedObjects()
Gets or sets flag of ignoring errors in source files.
|
DocumentInfo |
getInfo()
Gets document info.
|
JavaScriptCollection |
getJavaScript()
Collection of JavaScript of document level.
|
static List<String> |
getLocalFontPaths()
Copy of the list with actual font directories.
|
RootElement |
getLogicalStructure()
Gets logical structure of the document.
|
Metadata |
getMetadata()
Document metadata.
|
com.aspose.pdf.engine.data.types.IPdfStreamAccessor |
getMetadataStream()
Returns raw metadata stream
|
int |
getNonFullScreenPageMode()
Gets page mode, specifying how to display the document on exiting full-screen mode.
|
Object |
getObjectById(String id)
Gets a object with specified ID in the document.
|
IAppointment |
getOpenAction()
Gets action performed at document opening.
|
boolean |
getOptimizeSize()
Gets optimization flag.
|
OutlineCollection |
getOutlines()
Gets document outlines.
|
PageInfo |
getPageInfo()
Gets the page info.(for generator only)
|
PageLabelCollection |
getPageLabels()
Gets page labels in the document.
|
int |
getPageLayout()
Gets page layout which shall be used when the document is opened.
|
int |
getPageMode()
Gets page mode, specifying how document should be displayed when opened.
|
PageCollection |
getPages()
Gets collection of document pages.
|
int |
getPdfaFormat()
Gets pdfa format
|
int |
getPermissions()
Gets permissions of the document.
|
String |
getVersion()
Gets a version of Pdf from Pdf file header.
|
void |
getXmpMetadata(OutputStream output)
Get XMP metadata from document.
|
void |
importAnnotationsFromXfdf(String fileName)
Imports annotations from XFDF file to document.
|
boolean |
isAbsentFontTryToSubstitute()
Flag which informs about replacement of missing font.
|
boolean |
isEncrypted()
Gets encrypted status of the document.
|
static boolean |
isLicensed()
Gets licensed state of the system.
|
boolean |
isLinearized()
Gets a value indicating whether document is linearized.
|
boolean |
isPdfaCompliant()
Gets the is document pdfa compliant.
|
void |
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.
|
void |
optimizeResources()
Optimize resources in the document: 1.
|
void |
optimizeResources(Document.OptimizationOptions strategy)
Optimize resources in the document according to defined optimization strategy.
|
static void |
preSave(PageCollection pages) |
void |
processParagraphs()
Stores document into stream.
|
void |
removeMetadata()
Removes metadata from the document.
|
void |
removePdfaCompliance()
Remove pdfa compliance from the document
|
void |
repair()
Repairs broken document.
|
static void |
restoreLocalFontPath()
Restores list for standard font directories by default.
|
static boolean |
restricted(int index) |
void |
resumeUpdate()
resumes document update
|
void |
save()
Save document incrementally (i.e.
|
void |
save(com.aspose.ms.System.IO.FileStream output) |
void |
save(OutputStream output)
Stores document into stream.
|
void |
save(OutputStream outputStream,
int format)
Saves the document with a new name along with a file format.
|
void |
save(OutputStream outputStream,
SaveOptions options)
Saves the document to a stream with a save options.
|
void |
save(String outputFileName)
Saves document into the specified file.
|
void |
save(String outputFileName,
int format)
Saves the document with a new name along with a file format.
|
void |
save(String outputFileName,
SaveOptions options)
Saves the document with a new name setting its save options.
|
void |
saveInternal(com.aspose.ms.System.IO.Stream output)
For internal usage only
|
void |
saveXml(String file)
Save document to XML.
|
void |
sendTo(DocumentDevice device,
int fromPage,
int toPage,
OutputStream output)
Sends the certain pages of the document to the document device for processing.
|
void |
sendTo(DocumentDevice device,
int fromPage,
int toPage,
String outputFileName)
Sends the whole document to the document device for processing.
|
void |
sendTo(DocumentDevice device,
OutputStream output)
Sends the whole document to the document device for processing.
|
void |
sendTo(DocumentDevice device,
String outputFileName)
Sends the whole document to the document device for processing.
|
void |
setAbsentFontTryToSubstitute(boolean setAbsentFontTryToSubstitute)
Setting flag for set program determined font in case of absense font.
|
void |
setAllowReusePageContent(boolean value)
Allows to merge page contents to optimize docuement size.
|
void |
setBackground(Color value)
Sets the background color of the document.
|
void |
setCenterWindow(boolean value)
Sets flag specifying whether position of the document's window will be centerd on the screen.
|
void |
setCollection(Collection value)
Sets collection of document.
|
void |
setDirection(int value)
Sets reading order of text: L2R (left to right) or R2L (right to left).
|
void |
setDisplayDocTitle(boolean value)
Sets flag specifying whether document's window title bar should display document title.
|
void |
setEmbedStandardFonts(boolean value)
Property which declares that document must embed all standard Type1 fonts which has flag
IsEmbedded set into true.
|
void |
setEnableObjectUnload(boolean value)
Get or sets flag which enables document partially be unloaded from memory.
|
void |
setFitWindow(boolean value)
Sets flag specifying whether document window must be resized to fit the first displayed page.
|
void |
setHideMenubar(boolean value)
Sets flag specifying whether menu bar should be hidden when document is active.
|
void |
setHideToolBar(boolean value)
Set flag specifying whether toolbar should be hidden when document is active.
|
void |
setHideWindowUI(boolean value)
Sets flag specifying whether user interface elements should be hidden when document is
active.
|
void |
setIgnoreCorruptedObjects(boolean value)
Gets or sets flag of ignoring errors in source files.
|
void |
setLayersAdded(boolean value) |
void |
setLinearized(boolean value)
Sets a value indicating whether document is linearized.
|
static void |
setLocalFontPaths(List<String> newFontPathsList)
Sets user list with font paths
|
void |
setNonFullScreenPageMode(int value)
Sets page mode, specifying how to display the document on exiting full-screen mode.
|
void |
setOpenAction(IAppointment value)
Sets action performed at document opening.
|
void |
setOptimizeSize(boolean value)
Sets optimization flag.
|
void |
setPageInfo(PageInfo value)
Sets the page info.(for generator only)
|
void |
setPageLayout(int value)
Sets page layout which shall be used when the document is opened.
|
void |
setPageMode(int pageMode)
Sets page mode, specifying how document should be displayed when opened.
|
void |
setXmpMetadata(InputStream stream)
Set XMP metadata of document.
|
static void |
startOperation() |
void |
suppressUpdate()
Suppresses update contents data for all pages The contents is not updated until ResumeUpdate
is called
|
void |
updatePages() |
boolean |
validate(OutputStream outputLogStream,
int format)
Validate document into the specified file.
|
boolean |
validate(PdfFormatConversionOptions options)
Validate document into the specified file.
|
boolean |
validate(String outputLogFileName,
int format)
Validate document into the specified file.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitafterImport, bindXml, bindXml, convert, getEmbedStandardFonts, getObjectById, getXmpMetadata, isPdfaCompliant, repair, save, saveXml, setEmbedStandardFonts, setLayersAdded, setXmpMetadata, updatePagespublic com.aspose.pdf.ADocument.AbsentFontHandler AbsentFontHandler
public final PdfEvent<com.aspose.pdf.ADocument.FontSubstitutionHandler> FontSubstitution
It occurs when font replaces another font in document.
public Document()
Initializes empty document.
public Document(InputStream input)
Initialize new Document instance from the input stream.
input - Stream with pdf document.public Document(InputStream input, String password)
Initialize new Document instance from the input stream.
input - Input stream object, corresponding pdf is password protected.password - User or owner password.public Document(com.aspose.ms.System.IO.Stream input)
Initialize new Document instance from the input stream.
input - Stream with pdf document.public Document(InputStream input, String password, boolean isManagedStream)
Initialize new Document instance from the input stream.
input - Stream with pdf document.password - User or owner password.isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.public Document(InputStream input, boolean isManagedStream)
Initialize new Document instance from the input stream.
input - Stream with pdf document.isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.public Document(InputStream input, LoadOptions options)
Opens an existing document from a stream providing necessary converting to get pdf document.
input - Input stream to convert into pdf document.options - Represents properties for converting input into pdf document.public Document(String filename, LoadOptions options)
Opens an existing document from a file providing necessary converting to get pdf document.
filename - Input file to convert into pdf document.options - Represents properties for converting filename into pdf document.public Document(com.aspose.ms.System.IO.Stream input,
String password)
public Document(String filename)
Just init Document using filename. The same as Document(Stream).
filename - The name of the pdf document file.public Document(String filename, String password)
Initializes new instance of the Document class for working with encrypted document.
filename - Document file name.password - User or owner password.public Document(String filename, String password, boolean isManagedStream)
Initializes new instance of the Document class for working with encrypted document.
filename - Document file name.password - User or owner password.isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.public static List<String> getLocalFontPaths()
Copy of the list with actual font directories.
public static void addLocalFontPath(String path)
Add one more path to fonts.
path - String valuepublic static void setLocalFontPaths(List<String> newFontPathsList)
Sets user list with font paths
newFontPathsList - List<String> objectpublic static void restoreLocalFontPath()
Restores list for standard font directories by default.
public PageInfo getPageInfo()
Gets the page info.(for generator only)
getPageInfo in interface IDocumentpublic void setPageInfo(PageInfo value)
Sets the page info.(for generator only)
setPageInfo in interface IDocumentvalue - PageInfo objectpublic DestinationCollection getDestinations()
Gets the collection of destinations.
getDestinations in interface IDocumentpublic int getPdfaFormat()
Gets pdfa format
getPdfaFormat in interface IDocumentPdfFormatpublic void removePdfaCompliance()
Remove pdfa compliance from the document
removePdfaCompliance in interface IDocumentpublic Collection getCollection()
Gets collection of document.
getCollection in interface IDocumentpublic void setCollection(Collection value)
Sets collection of document.
setCollection in interface IDocumentvalue - Collection objectpublic com.aspose.pdf.engine.IPdfDocument getEngineDoc()
Instance of IPdfDocument used to access to internal document structure. Internal only
getEngineDoc in interface IDocumentpublic String getVersion()
Gets a version of Pdf from Pdf file header.
getVersion in interface IDocumentpublic IAppointment getOpenAction()
Gets action performed at document opening.
getOpenAction in interface IDocument
Example demonstrates how to get CenterWindow flag:Document document = new Document("sample.pdf"); IAppointment value = document.getOpenAction();
public void setOpenAction(IAppointment value)
Sets action performed at document opening.
setOpenAction in interface IDocumentvalue - IAppointment valuepublic boolean getHideToolBar()
Gets flag specifying whether toolbar should be hidden when document is active.
getHideToolBar in interface IDocument
Example demonstrates how to get HideToolBar flag:Document document = new Document("sample.pdf"); boolean value = document.getHideToolBar();
public void setHideToolBar(boolean value)
Set flag specifying whether toolbar should be hidden when document is active.
setHideToolBar in interface IDocumentvalue - boolean valuepublic boolean getHideMenubar()
Gets flag specifying whether menu bar should be hidden when document is active.
getHideMenubar in interface IDocument
Example demonstrates how to get HideMenubar flag:Document document = new Document("sample.pdf"); boolean value = document.getHideMenubar();
public void setHideMenubar(boolean value)
Sets flag specifying whether menu bar should be hidden when document is active.
setHideMenubar in interface IDocumentvalue - boolean valuepublic boolean getHideWindowUI()
Gets flag specifying whether user interface elements should be hidden when document is active.
getHideWindowUI in interface IDocument
Example demonstrates how to get HideWindowUI flag:Document document = new Document("sample.pdf"); boolean value = document.getHideWindowUI();
public void setHideWindowUI(boolean value)
Sets flag specifying whether user interface elements should be hidden when document is active.
setHideWindowUI in interface IDocumentvalue - boolean valuepublic boolean getFitWindow()
Gets flag specifying whether document window must be resized to fit the first displayed page.
getFitWindow in interface IDocument
Example demonstrates how to get FitWindow flag:Document document = new Document("sample.pdf"); boolean value = document.getFitWindow();
public void setFitWindow(boolean value)
Sets flag specifying whether document window must be resized to fit the first displayed page.
setFitWindow in interface IDocumentvalue - boolean valuepublic boolean getCenterWindow()
Gets flag specifying whether position of the document's window will be centerd on the screen.
getCenterWindow in interface IDocument
Example demonstrates how to get CenterWindow flag:Document document = new Document("sample.pdf"); boolean value = document.getCenterWindow();
public void setCenterWindow(boolean value)
Sets flag specifying whether position of the document's window will be centerd on the screen.
setCenterWindow in interface IDocumentvalue - boolean valuepublic boolean getDisplayDocTitle()
Gets flag specifying whether document's window title bar should display document title.
getDisplayDocTitle in interface IDocument
Example demonstrates how to get DisplayDocTitle flag:Document document = new Document("sample.pdf"); boolean value = document.getDisplayDocTitle();
public void setDisplayDocTitle(boolean value)
Sets flag specifying whether document's window title bar should display document title.
setDisplayDocTitle in interface IDocumentvalue - boolean valuepublic PageCollection getPages()
Gets collection of document pages. Note that pages are numbered from 1 in collection.
getPages in interface IDocument
Example below demonstrates how to operate with the document pages: How to obtain number of pages and how to obtain rectangle of starting page of the document.Document document = new Document("sample.pdf"); PageCollection pages = document.getPages(); System.out.println("Document contains " + pages.size()); Page page = pages.get_Item(1); Rectangle rect = page.getRect();
public OutlineCollection getOutlines()
Gets document outlines.
getOutlines in interface IDocumentpublic DocumentActionCollection getActions()
Gets document actions. This property is instance of DocumentActions class which allows to get/set BeforClosing, BeforSaving, etc. actions.
getActions in interface IDocument
This example demonstrates how to obtain after open action of the document:Document document = new Document("PdfWithOpenAction.pdf"); DocumentActionCollection actions = document.getActions(); PdfAction afterSavingAction = actions.getAfterSaving();
public Form getForm()
Gets Acro Form of the document.
public EmbeddedFileCollection getEmbeddedFiles()
Gets collection of files embedded to document.
getEmbeddedFiles in interface IDocumentpublic int getDirection()
Gets reading order of text: L2R (left to right) or R2L (right to left).
getDirection in interface IDocumentDirectionpublic void setDirection(int value)
Sets reading order of text: L2R (left to right) or R2L (right to left).
setDirection in interface IDocumentvalue - int valueDirectionpublic int getPageMode()
Gets page mode, specifying how document should be displayed when opened.
getPageMode in interface IDocumentPageModepublic void setPageMode(int pageMode)
Sets page mode, specifying how document should be displayed when opened.
setPageMode in interface IDocumentpageMode - int valuePageModepublic int getNonFullScreenPageMode()
Gets page mode, specifying how to display the document on exiting full-screen mode.
getNonFullScreenPageMode in interface IDocumentPageModepublic void setNonFullScreenPageMode(int value)
Sets page mode, specifying how to display the document on exiting full-screen mode.
setNonFullScreenPageMode in interface IDocumentvalue - int valuePageModepublic int getPageLayout()
Gets page layout which shall be used when the document is opened.
getPageLayout in interface IDocumentPageLayoutpublic void setPageLayout(int value)
Sets page layout which shall be used when the document is opened.
setPageLayout in interface IDocumentvalue - int valuePageLayoutpublic String getFileName()
Name of the PDF file that caused this document
getFileName in interface IDocumentpublic DocumentInfo getInfo()
Gets document info.
public Metadata getMetadata()
Document metadata. (A PDF document may include general information, such as the document's title, author, and creation and modification dates. Such global information about the document (as opposed to its content or structure) is called metadata and is intended to assist in cataloguing and searching for documents in external databases.)
getMetadata in interface IDocumentpublic RootElement getLogicalStructure()
Gets logical structure of the document.
getLogicalStructure in interface IDocumentpublic void processParagraphs()
Stores document into stream.
processParagraphs in interface IDocumentpublic void saveInternal(com.aspose.ms.System.IO.Stream output)
For internal usage only
saveInternal in interface IDocumentoutput - For internal usage onlypublic void save(OutputStream output)
Stores document into stream.
public void save(String outputFileName)
Saves document into the specified file.
public void exportAnnotationsToXfdf(String fileName)
Exports all document annotations to XFDF file
exportAnnotationsToXfdf in interface IDocumentfileName - XFDF file namepublic void sendTo(DocumentDevice device, OutputStream output)
Sends the whole document to the document device for processing.
public void sendTo(DocumentDevice device, int fromPage, int toPage, OutputStream output)
Sends the certain pages of the document to the document device for processing.
public void sendTo(DocumentDevice device, String outputFileName)
Sends the whole document to the document device for processing.
public void sendTo(DocumentDevice device, int fromPage, int toPage, String outputFileName)
Sends the whole document to the document device for processing.
public void removeMetadata()
Removes metadata from the document.
removeMetadata in interface IDocumentpublic void importAnnotationsFromXfdf(String fileName)
Imports annotations from XFDF file to document.
importAnnotationsFromXfdf in interface IDocumentfileName - XFDF file namepublic boolean validate(String outputLogFileName, int format)
Validate document into the specified file.
public boolean convert(String outputLogFileName, int format, int action)
Convert document and save errors into the specified file.
public boolean validate(OutputStream outputLogStream, int format)
public boolean convert(String outputLogFileName, int format, int action, int transparencyAction)
Convert document and save errors into the specified file.
convert in interface IDocumentoutputLogFileName - Path to file where the comments will be stored.format - The pdf format.action - Action for objects that can not be convertedtransparencyAction - Action for image masked objectsPdfFormat,
ConvertErrorAction,
ConvertTransparencyActionpublic boolean convert(Document.CallBackGetHocr callback)
public boolean convertInternal(com.aspose.ms.System.IO.Stream outputLogStream,
int format,
int action)
Convert document and save errors into the specified stream.
convertInternal in interface IDocumentoutputLogStream - Stream where the comments will be stored.format - Pdf format.action - Action for objects that can not be convertedExceptionpublic boolean convert(OutputStream outputLogStream, int format, int action)
Convert document and save errors into the specified stream.
public void flatten()
Removes all fields from the document and place their values instead.
public int getCryptoAlgorithm()
Gets security settings if document is encrypted. If document is not encrypted then corresponding exception will be raised in .net 1.1 or CryptoAlgorithm will be null for other .net versions.
getCryptoAlgorithm in interface IDocumentCryptoAlgorithmpublic void encrypt(String userPassword, String ownerPassword, DocumentPrivilege privileges, int cryptoAlgorithm, boolean usePdf20)
Encrypts the document. Call then Save to get encrypted version of the document.
encrypt in interface IDocumentuserPassword - User password.ownerPassword - Owner password.privileges - Document permissions, see Permissions for details.cryptoAlgorithm - Cryptographic algorithm, see CryptoAlgorithm for details.usePdf20 - Support for revision 6 (Extension 8).CryptoAlgorithmpublic void encrypt(String userPassword, String ownerPassword, int permissions, int cryptoAlgorithm)
Encrypts the document. Call then Save to get encrypted version of the document.
public void encrypt(String userPassword, String ownerPassword, int permissions, int cryptoAlgorithm, boolean usePdf20)
Encrypts the document. Call then Save to get encrypted version of the document.
encrypt in interface IDocumentuserPassword - User password.ownerPassword - Owner password.permissions - Document permissions, see Permissions for details.cryptoAlgorithm - Cryptographic algorithm, see CryptoAlgorithm for details.usePdf20 - Support for revision 6 (Extension 8).Permissions,
CryptoAlgorithmpublic void changePasswords(String ownerPassword, String newUserPassword, String newOwnerPassword)
Changes document passwords. This action can be done only using owner password/>.
changePasswords in interface IDocumentownerPassword - Owner password.newUserPassword - New user password.newOwnerPassword - New owner password.public boolean isLinearized()
Gets a value indicating whether document is linearized.
isLinearized in interface IDocumentpublic void setLinearized(boolean value)
Sets a value indicating whether document is linearized.
setLinearized in interface IDocumentvalue - boolean valuepublic void decrypt()
Decrypts the document. Call then Save to obtain decrypted version of the document.
public int getPermissions()
Gets permissions of the document.
getPermissions in interface IDocumentpublic boolean isEncrypted()
Gets encrypted status of the document. True if document is encrypted.
isEncrypted in interface IDocumentpublic void 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. Invoking this method doesn't actually saves the document. On the contrary the document only is prepared to have optimized structure, call then Save to get optimized document.
public void save()
Save document incrementally (i.e. using incremental update technque).
public void save(String outputFileName, int format)
Saves the document with a new name along with a file format.
outputFileName - Path to file where the document will be stored.format - Format options.SaveFormatpublic void save(OutputStream outputStream, int format)
Saves the document with a new name along with a file format.
save in interface IDocumentoutputStream - Stream where the document will be stored.format - Format options.com.aspose.ms.System.ArgumentException - ArgumentException when HtmlSaveOptions is passed to a method. Save a document
to the html stream is not supported. Please use method save to the file.SaveFormatpublic void save(String outputFileName, SaveOptions options)
Saves the document with a new name setting its save options.
public void save(OutputStream outputStream, SaveOptions options)
Saves the document to a stream with a save options.
save in interface IDocumentoutputStream - Stream where the document will be stored.options - Save options.com.aspose.ms.System.ArgumentException - ArgumentException when HtmlSaveOptions is passed to a method. Save a document
to the html stream is not supported. Please use method save to the file.public com.aspose.pdf.engine.data.types.IPdfStreamAccessor getMetadataStream()
Returns raw metadata stream
getMetadataStream in interface IDocumentpublic void suppressUpdate()
Suppresses update contents data for all pages The contents is not updated until ResumeUpdate is called
suppressUpdate in interface IDocumentpublic void resumeUpdate()
resumes document update
resumeUpdate in interface IDocumentpublic void dispose()
Closes all resources used by this document.
public Color getBackground()
Gets the background color of the document.
getBackground in interface IDocumentpublic void setBackground(Color value)
Sets the background color of the document.
setBackground in interface IDocumentvalue - Color objectpublic Copier getDefaultCopier()
Returns copier used for coping pages to this document.
getDefaultCopier in interface IDocumentpublic void optimizeResources()
Optimize resources in the document: 1. Resources which are not used on the document pages are removed; 2. Equal resources are joined into one object; 3. Unused objects are deleted.
optimizeResources in interface IDocumentpublic void optimizeResources(Document.OptimizationOptions strategy)
Optimize resources in the document according to defined optimization strategy.
optimizeResources in interface IDocumentstrategy - Optimization strategy.public boolean getOptimizeSize()
Gets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.
getOptimizeSize in interface IDocumentpublic void setOptimizeSize(boolean value)
Sets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.
setOptimizeSize in interface IDocumentvalue - boolean valuepublic boolean getIgnoreCorruptedObjects()
Gets or sets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true.
getIgnoreCorruptedObjects in interface IDocumentpublic void setIgnoreCorruptedObjects(boolean value)
Gets or sets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true.
setIgnoreCorruptedObjects in interface IDocumentvalue - boolean valuepublic Object getCatalogValue(String key)
Returns item value from catalog dictionary.
getCatalogValue in interface IDocumentkey - The key of item.public PageLabelCollection getPageLabels()
Gets page labels in the document.
getPageLabels in interface IDocumentpublic void freeMemory()
Clears memory
freeMemory in interface IDocumentpublic boolean isAbsentFontTryToSubstitute()
isAbsentFontTryToSubstitute in interface IDocumentpublic void setAbsentFontTryToSubstitute(boolean setAbsentFontTryToSubstitute)
setAbsentFontTryToSubstitute in interface IDocumentpublic JavaScriptCollection getJavaScript()
Collection of JavaScript of document level.
public static boolean isLicensed()
Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.
public void setLayersAdded(boolean value)
setLayersAdded in interface IDocumentpublic static boolean restricted(int index)
public static void cutByRestriction(Iterable list)
public static void startOperation()
public static void endOperation()
public boolean isPdfaCompliant()
Gets the is document pdfa compliant.
isPdfaCompliant in interface IDocumentpublic boolean getEmbedStandardFonts()
Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false.
getEmbedStandardFonts in interface IDocumentpublic void setEmbedStandardFonts(boolean value)
Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false.
setEmbedStandardFonts in interface IDocumentpublic static void preSave(PageCollection pages)
public void save(com.aspose.ms.System.IO.FileStream output)
public boolean convert(PdfFormatConversionOptions options)
Convert document using specified conversion options
options - set of options for convert PDF documentpublic boolean validate(PdfFormatConversionOptions options)
Validate document into the specified file.
options - set of options for convert PDF documentpublic boolean convert(Document.CallBackGetHocr callback, boolean isTestVisible)
public void updatePages()
updatePages in interface IDocumentpublic void close()
Closes all resources used by this document.
public boolean getAllowReusePageContent()
Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed.
public void setAllowReusePageContent(boolean value)
Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed.
value - boolean valuepublic void afterImport()
Enumerate all registered annotations and call AfterImport for each of them. InternalMethod
afterImport in interface IDocumentpublic void saveXml(String file)
Save document to XML.
public Object getObjectById(String id)
Gets a object with specified ID in the document.
getObjectById in interface IDocumentid - The object id.public void bindXml(String file)
Bind xml to document
public void bindXml(InputStream xmlStream, InputStream xslStream)
Bind xml/xsl to document
xmlStream - The xml stream.xslStream - The xsl stream if XSLT is used.public void getXmpMetadata(OutputStream output)
Get XMP metadata from document.
getXmpMetadata in interface IDocumentoutput - Stream where metadata will be stored.public void setXmpMetadata(InputStream stream)
Set XMP metadata of document.
setXmpMetadata in interface IDocumentstream - Stream which contains XMP metadata.public boolean getEnableObjectUnload()
Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perofmance.
public void setEnableObjectUnload(boolean value)
Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perofmance.
value - boolean valueCopyright © 2016 Aspose. All Rights Reserved.