Document (Aspose.Pdf for Android via Java (18.6) API Documentation)

java.lang.Object
- com.aspose.pdf.Document

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IDocument
```
public final class Document
extends Object
implements IDocument
```
Class representing PDF document

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ADocument.FontSubstitutionHandler` It represents class with abstract method that usually supplied by information about missing font while processing documents.
`static interface`	`Document.CallBackGetHocr`
`static class`	`Document.OptimizationOptions` Class which describes document optimization algorithm.

Field Summary

Fields
Modifier and Type Field and Description

PdfEvent<ADocument.FontSubstitutionHandler> FontSubstitution
It occurs when font replaces another font in document.

Fields
Modifier and Type	Field and Description
`PdfEvent<ADocument.FontSubstitutionHandler>`	`FontSubstitution` It occurs when font replaces another font in document.

Constructor Summary

Constructors
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)`
`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.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addLocalFontPath(String path)` Add one more path to fonts
`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(OutputStream outputLogStream, int format, int action)` Convert document and save errors into the specified stream.
`boolean`	`convert(String outputLogFileName, int format, int action)` Convert document and save errors into the specified file.
`boolean`	`convert(com.aspose.ms.System.Xml.XmlTextWriter xml, int format, boolean onlyValidation, int action)` Convert the PDF Document and log results.
`boolean`	`convertInternal(com.aspose.ms.System.IO.Stream outputLogStream, int format, int action)` Convert document and save errors into the specified stream.
`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.
`Color`	`getBackground()` Gets the background color of the document.
`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.
`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.
`int`	`getFontReplaceBehavior()` Gets the TextEditOptions.FontReplace
`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 or sets 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.
`static List`	`getLocalFontPaths()` List for standard font directories in different OS
`RootElement`	`getLogicalStructure()` Gets logical structure of the document.
`Metadata`	`getMetadata()` Document metadata.
`com.aspose.pdf.engine.data.types.IPdfStreamAccessor`	`getMetadataStream()` Returns raw metadata stream
`NamedDestinationCollection`	`getNamedDestinations()` Collection of Named Destination in the document.
`int`	`getNonFullScreenPageMode()` Gets page mode, specifying how to display the document on exiting full-screen mode.
`IAppointment`	`getOpenAction()` Gets action performed at document opening.
`boolean`	`getOptimizeSize()` Gets optimization flag.
`OutlineCollection`	`getOutlines()` Gets document outlines.
`PageInfo`	`getPageInfo()` Gets the page info.
`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()`
`int`	`getPermissions()` Gets permissions of the document.
`String`	`getVersion()` Gets a version of Pdf from Pdf file header.
`void`	`importAnnotationsFromXfdf(String fileName)` Imports annotations from XFDF file to document.
`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.
`void`	`isLinearized(boolean value)` Sets a value indicating whether document is linearized.
`boolean`	`isPdfaCompliant()`
`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.
`static void`	`restoreLocalFontPath()` Restores list for standard font directories by default.
`void`	`resumeUpdate()` resumes document update
`void`	`save()` Save document incrementally (i.e. using incremental update technque).
`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)` Stores document into stream.
`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`	`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`	`setFitWindow(boolean value)` Sets flag specifying whether document window must be resized to fit the first displayed page.
`void`	`setFontReplaceBehavior(int value)` Sets the TextEditOptions.FontReplace
`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.
`static void`	`setLocalFontPaths(List 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.
`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.
`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)`
`boolean`	`validate(String outputLogFileName, int format)` Validate document into the specified file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.pdf.IDocument
getEmbedStandardFonts, getNamedDestinations, save, setEmbedStandardFonts, updatePages

- Field Detail
  - FontSubstitution
```
public final PdfEvent<ADocument.FontSubstitutionHandler> FontSubstitution
```
    It occurs when font replaces another font in document.
- Constructor Detail
  - Document
```
public Document()
```
    Initializes empty document.
  - Document
```
public Document(InputStream input)
```
    Initialize new Document instance from the input stream.
    
    Parameters:
    input - Stream with pdf document.
  - Document
```
public Document(InputStream input,
        String password)
```
  - Document
```
public Document(com.aspose.ms.System.IO.Stream input)
```
    Initialize new Document instance from the input stream.
    
    Parameters:
    input - Stream with pdf document.
  - Document
```
public Document(InputStream input,
        String password,
        boolean isManagedStream)
```
    Initialize new Document instance from the input stream.
    
    Parameters:
    input - Stream with pdf document.
    password - User or owner password.
    isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.
  - Document
```
public Document(InputStream input,
        boolean isManagedStream)
```
    Initialize new Document instance from the input stream.
    
    Parameters:
    input - Stream with pdf document.
    isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.
  - Document
```
public Document(InputStream input,
        LoadOptions options)
```
    Opens an existing document from a stream providing necessary converting to get pdf document.
    
    Parameters:
    input - Input stream to convert into pdf document.
    options - Represents properties for converting input into pdf document.
  - Document
```
public Document(String filename,
        LoadOptions options)
```
    Opens an existing document from a file providing necessary converting to get pdf document.
    
    Parameters:
    filename - Input file to convert into pdf document.
    options - Represents properties for converting filename into pdf document.
  - Document
```
public Document(com.aspose.ms.System.IO.Stream input,
        String password)
```
  - Document
```
public Document(String filename)
```
    Just init Document using filename. The same as Document(Stream).
    
    Parameters:
    filename - The name of the pdf document file.
  - Document
```
public Document(String filename,
        String password)
```
    Initializes new instance of the Document class for working with encrypted document.
    
    Parameters:
    filename - Document file name.
    password - User or owner password.
  - Document
```
public Document(String filename,
        String password,
        boolean isManagedStream)
```
    Initializes new instance of the Document class for working with encrypted document.
    
    Parameters:
    filename - Document file name.
    password - User or owner password.
    isManagedStream - if set to true inner stream is closed before exit; otherwise, is not.
- Method Detail
  - getLocalFontPaths
```
public static List getLocalFontPaths()
```
    List for standard font directories in different OS
    
    Returns:
    list of String
  - addLocalFontPath
```
public static void addLocalFontPath(String path)
```
    Add one more path to fonts
    
    Parameters:
    path - String value
  - setLocalFontPaths
```
public static void setLocalFontPaths(List newFontPathsList)
```
    Sets user list with font paths
    
    Parameters:
    newFontPathsList - List<String> object
  - restoreLocalFontPath
```
public static void restoreLocalFontPath()
```
    Restores list for standard font directories by default.
  - getPageInfo
```
public PageInfo getPageInfo()
```
    Gets the page info.(for generator only)
    
    Specified by:
    
    getPageInfo in interface IDocument
    
    Returns:
    The page info.
  - setPageInfo
```
public void setPageInfo(PageInfo value)
```
    Sets the page info.(for generator only)
    
    Specified by:
    
    setPageInfo in interface IDocument
  - getFontReplaceBehavior
```
public int getFontReplaceBehavior()
```
    Gets the TextEditOptions.FontReplace
    
    Specified by:
    
    getFontReplaceBehavior in interface IDocument
  - setFontReplaceBehavior
```
public void setFontReplaceBehavior(int value)
```
    Sets the TextEditOptions.FontReplace
    
    Specified by:
    
    setFontReplaceBehavior in interface IDocument
  - getDestinations
```
public DestinationCollection getDestinations()
```
    Gets the collection of destinations.
  - getCollection
```
public Collection getCollection()
```
    Gets collection of document.
    
    Specified by:
    
    getCollection in interface IDocument
  - setCollection
```
public void setCollection(Collection value)
```
    Sets collection of document.
    
    Specified by:
    
    setCollection in interface IDocument
  - getEngineDoc
```
public com.aspose.pdf.engine.IPdfDocument getEngineDoc()
```
    Instance of IPdfDocument used to access to internal document structure.
    
    Specified by:
    
    getEngineDoc in interface IDocument
  - getVersion
```
public String getVersion()
```
    Gets a version of Pdf from Pdf file header.
    
    Specified by:
    
    getVersion in interface IDocument
  - getOpenAction
```
public IAppointment getOpenAction()
```
    Gets action performed at document opening. Example demonstrates how to get CenterWindow flag: Document document = new Document("sample.pdf"); IAppointment value = document.getOpenAction();
    
    Specified by:
    
    getOpenAction in interface IDocument
  - setOpenAction
```
public void setOpenAction(IAppointment value)
```
    Sets action performed at document opening.
    
    Specified by:
    
    setOpenAction in interface IDocument
  - getHideToolBar
```
public boolean getHideToolBar()
```
    Gets flag specifying whether toolbar should be hidden when document is active. Example demonstrates how to get HideToolBar flag: Document document = new Document("sample.pdf"); booleanvalue = document.getHideToolBar();
    
    Specified by:
    
    getHideToolBar in interface IDocument
  - setHideToolBar
```
public void setHideToolBar(boolean value)
```
    Set flag specifying whether toolbar should be hidden when document is active.
    
    Specified by:
    
    setHideToolBar in interface IDocument
  - getHideMenubar
```
public boolean getHideMenubar()
```
    Gets flag specifying whether menu bar should be hidden when document is active. Example demonstrates how to get HideMenubar flag: Document document = new Document("sample.pdf"); booleanvalue = document.getHideMenubar();
    
    Specified by:
    
    getHideMenubar in interface IDocument
  - setHideMenubar
```
public void setHideMenubar(boolean value)
```
    Sets flag specifying whether menu bar should be hidden when document is active.
    
    Specified by:
    
    setHideMenubar in interface IDocument
  - getHideWindowUI
```
public boolean getHideWindowUI()
```
    Gets or sets flag specifying whether user interface elements should be hidden when document is active. Example demonstrates how to get HideWindowUI flag: Document document = new Document("sample.pdf"); booleanvalue = document.getHideWindowUI();
    
    Specified by:
    
    getHideWindowUI in interface IDocument
  - setHideWindowUI
```
public void setHideWindowUI(boolean value)
```
    Sets flag specifying whether user interface elements should be hidden when document is active.
    
    Specified by:
    
    setHideWindowUI in interface IDocument
  - getFitWindow
```
public boolean getFitWindow()
```
    Gets flag specifying whether document window must be resized to fit the first displayed page. Example demonstrates how to get FitWindow flag: Document document = new Document("sample.pdf"); booleanvalue = document.getFitWindow();
    
    Specified by:
    
    getFitWindow in interface IDocument
  - setFitWindow
```
public void setFitWindow(boolean value)
```
    Sets flag specifying whether document window must be resized to fit the first displayed page.
    
    Specified by:
    
    setFitWindow in interface IDocument
  - getCenterWindow
```
public boolean getCenterWindow()
```
    Gets flag specifying whether position of the document's window will be centerd on the screen. Example demonstrates how to get CenterWindow flag: Document document = new Document("sample.pdf"); booleanvalue = document.getCenterWindow();
    
    Specified by:
    
    getCenterWindow in interface IDocument
  - setCenterWindow
```
public void setCenterWindow(boolean value)
```
    Sets flag specifying whether position of the document's window will be centerd on the screen.
    
    Specified by:
    
    setCenterWindow in interface IDocument
  - getDisplayDocTitle
```
public boolean getDisplayDocTitle()
```
    Gets flag specifying whether document's window title bar should display document title. Example demonstrates how to get DisplayDocTitle flag: Document document = new Document("sample.pdf"); booleanvalue = document.getDisplayDocTitle();
    
    Specified by:
    
    getDisplayDocTitle in interface IDocument
  - setDisplayDocTitle
```
public void setDisplayDocTitle(boolean value)
```
    Sets flag specifying whether document's window title bar should display document title.
    
    Specified by:
    
    setDisplayDocTitle in interface IDocument
  - getPages
```
public PageCollection getPages()
```
    Gets collection of document pages. Note that pages are numbered from 1 in collection. 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"); Pages pages = document.Pages; Console.WriteLine("Document contains " + pages.Count); Page page = Pages[1]; Rectangle rect = page.Rect;
    
    Specified by:
    
    getPages in interface IDocument
  - getOutlines
```
public OutlineCollection getOutlines()
```
    Gets document outlines.
    
    Specified by:
    
    getOutlines in interface IDocument
  - getActions
```
public DocumentActionCollection getActions()
```
    Gets document actions. This property is instance of DocumentActions class which allows to get/set BeforClosing, BeforSaving, etc. actions. This example demonstrates how to obtain after open action of the document: Document document = new Document("PdfWithOpenAction.pdf"); DocumentActions actions = document.Actions; com.aspose.pdf.Action afterSavingAction = actions.AfterSaving;
    
    Specified by:
    
    getActions in interface IDocument
  - getForm
```
public Form getForm()
```
    Gets Acro Form of the document.
    
    Specified by:
    
    getForm in interface IDocument
  - getEmbeddedFiles
```
public EmbeddedFileCollection getEmbeddedFiles()
```
    Gets collection of files embedded to document.
    
    Specified by:
    
    getEmbeddedFiles in interface IDocument
  - getDirection
```
public int getDirection()
```
    Gets reading order of text: L2R (left to right) or R2L (right to left).
    
    Specified by:
    
    getDirection in interface IDocument
  - setDirection
```
public void setDirection(int value)
```
    Sets reading order of text: L2R (left to right) or R2L (right to left).
    
    Specified by:
    
    setDirection in interface IDocument
  - getPageMode
```
public int getPageMode()
```
    Gets page mode, specifying how document should be displayed when opened.
    
    Specified by:
    
    getPageMode in interface IDocument
  - setPageMode
```
public void setPageMode(int pageMode)
```
    Sets page mode, specifying how document should be displayed when opened.
    
    Specified by:
    
    setPageMode in interface IDocument
  - getNonFullScreenPageMode
```
public int getNonFullScreenPageMode()
```
    Gets page mode, specifying how to display the document on exiting full-screen mode.
    
    Specified by:
    
    getNonFullScreenPageMode in interface IDocument
  - setNonFullScreenPageMode
```
public void setNonFullScreenPageMode(int value)
```
    Sets page mode, specifying how to display the document on exiting full-screen mode.
    
    Specified by:
    
    setNonFullScreenPageMode in interface IDocument
  - getPageLayout
```
public int getPageLayout()
```
    Gets page layout which shall be used when the document is opened.
    
    Specified by:
    
    getPageLayout in interface IDocument
  - setPageLayout
```
public void setPageLayout(int value)
```
    Sets page layout which shall be used when the document is opened.
    
    Specified by:
    
    setPageLayout in interface IDocument
  - getFileName
```
public String getFileName()
```
    Name of the PDF file that caused this document
    
    Specified by:
    
    getFileName in interface IDocument
  - getInfo
```
public DocumentInfo getInfo()
```
    Gets document info.
    
    Specified by:
    
    getInfo in interface IDocument
  - getMetadata
```
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.)
    
    Specified by:
    
    getMetadata in interface IDocument
  - getLogicalStructure
```
public RootElement getLogicalStructure()
```
    Gets logical structure of the document.
    
    Specified by:
    
    getLogicalStructure in interface IDocument
  - processParagraphs
```
public void processParagraphs()
```
    Stores document into stream.
    
    Specified by:
    
    processParagraphs in interface IDocument
  - saveInternal
```
public void saveInternal(com.aspose.ms.System.IO.Stream output)
```
    Stores document into stream.
    
    Specified by:
    
    saveInternal in interface IDocument
    
    Parameters:
    output - Stream where document shell be stored.
  - save
```
public void save(OutputStream output)
```
    Stores document into stream.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    output - Stream where document shell be stored.
  - save
```
public void save(String outputFileName)
```
    Saves document into the specified file.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    outputFileName - Path to file where the document will be stored.
  - exportAnnotationsToXfdf
```
public void exportAnnotationsToXfdf(String fileName)
```
    Exports all document annotations to XFDF file
    
    Specified by:
    
    exportAnnotationsToXfdf in interface IDocument
    
    Parameters:
    fileName - XFDF file name
  - sendTo
```
public void sendTo(DocumentDevice device,
          OutputStream output)
```
    Sends the whole document to the document device for processing.
    
    Specified by:
    
    sendTo in interface IDocument
    
    Parameters:
    device - Document device which is used to process the document.
    output - Output stream contains the results of the document processing with given device.
  - sendTo
```
public void sendTo(DocumentDevice device,
          int fromPage,
          int toPage,
          OutputStream output)
```
    Sends the certain pages of the document to the document device for processing.
    
    Specified by:
    
    sendTo in interface IDocument
    
    Parameters:
    device - Document device which is used to process the document.
    fromPage - The first page for processing.
    toPage - The last page for processing.
    output - Output stream contains the results of the document pages processing with given device.
  - sendTo
```
public void sendTo(DocumentDevice device,
          String outputFileName)
```
    Sends the whole document to the document device for processing.
    
    Specified by:
    
    sendTo in interface IDocument
    
    Parameters:
    device - Document device which is used to process the document.
    outputFileName - Output file name with the results of processing.
  - sendTo
```
public void sendTo(DocumentDevice device,
          int fromPage,
          int toPage,
          String outputFileName)
```
    Sends the whole document to the document device for processing.
    
    Specified by:
    
    sendTo in interface IDocument
    
    Parameters:
    device - Document device which is used to process the document.
    fromPage - The first page for processing.
    toPage - The last page for processing.
    outputFileName - Output file name with the results of processing.
  - removeMetadata
```
public void removeMetadata()
```
    Removes metadata from the document.
    
    Specified by:
    
    removeMetadata in interface IDocument
  - importAnnotationsFromXfdf
```
public void importAnnotationsFromXfdf(String fileName)
```
    Imports annotations from XFDF file to document.
    
    Specified by:
    
    importAnnotationsFromXfdf in interface IDocument
    
    Parameters:
    fileName - XFDF file name
  - validate
```
public boolean validate(String outputLogFileName,
               int format)
```
    Validate document into the specified file.
    
    Specified by:
    
    validate in interface IDocument
    
    Parameters:
    outputLogFileName - Path to file where the comments will be stored.
    format - Pdf format.
    
    Throws:
    
    Exception
  - convert
```
public boolean convert(String outputLogFileName,
              int format,
              int action)
```
    Convert document and save errors into the specified file.
    
    Specified by:
    
    convert in interface IDocument
    
    Parameters:
    outputLogFileName - Path to file where the comments will be stored.
    format - Pdf format.
    action - Action for objects that can not be converted
  - convert
```
public boolean convert(Document.CallBackGetHocr callback)
```
    Convert document and save errors into the specified file.
    
    Parameters:
    callback - Action for objects that can not be converted
    
    Returns:
  - convertInternal
```
public boolean convertInternal(com.aspose.ms.System.IO.Stream outputLogStream,
                      int format,
                      int action)
```
    Convert document and save errors into the specified stream.
    
    Specified by:
    
    convertInternal in interface IDocument
    
    Parameters:
    outputLogStream - Stream where the comments will be stored.
    format - Pdf format.
    action - Action for objects that can not be converted
  - convert
```
public boolean convert(OutputStream outputLogStream,
              int format,
              int action)
```
    Convert document and save errors into the specified stream.
    
    Specified by:
    
    convert in interface IDocument
    
    Parameters:
    outputLogStream - Stream where the comments will be stored.
    format - Pdf format.
    action - Action for objects that can not be converted
    See Also:
    PdfFormat, ConvertErrorAction
  - convert
```
public boolean convert(com.aspose.ms.System.Xml.XmlTextWriter xml,
              int format,
              boolean onlyValidation,
              int action)
```
    Convert the PDF Document and log results.
    
    Specified by:
    
    convert in interface IDocument
    
    Parameters:
    xml - The log.
    format - Pdf format.
    onlyValidation - Only document validation.
    action - Action for objects that can not be converted
    
    Returns:
  - flatten
```
public void flatten()
```
    Removes all fields from the document and place their values instead.
    
    Specified by:
    
    flatten in interface IDocument
  - getCryptoAlgorithm
```
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.
    
    Specified by:
    
    getCryptoAlgorithm in interface IDocument
  - encrypt
```
public 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.
    
    Parameters:
    userPassword - 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).
  - encrypt
```
public void encrypt(String userPassword,
           String ownerPassword,
           int permissions,
           int cryptoAlgorithm)
```
    Encrypts the document. Call then Save to get encrypted version of the document.
    
    Specified by:
    
    encrypt in interface IDocument
    
    Parameters:
    userPassword - User password.
    ownerPassword - Owner password.
    permissions - Document permissions, see Permissions for details.
    cryptoAlgorithm - Cryptographic algorithm, see CryptoAlgorithm for details.
  - encrypt
```
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.
    
    Parameters:
    userPassword - 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).
  - changePasswords
```
public void changePasswords(String ownerPassword,
                   String newUserPassword,
                   String newOwnerPassword)
```
    Changes document passwords. This action can be done only using owner password.
    
    Specified by:
    
    changePasswords in interface IDocument
    
    Parameters:
    ownerPassword - Owner password.
    newUserPassword - New user password.
    newOwnerPassword - New owner password.
  - isLinearized
```
public boolean isLinearized()
```
    Gets a value indicating whether document is linearized.
    
    Specified by:
    
    isLinearized in interface IDocument
  - isLinearized
```
public void isLinearized(boolean value)
```
    Sets a value indicating whether document is linearized.
    
    Specified by:
    
    isLinearized in interface IDocument
  - decrypt
```
public void decrypt()
```
    Decrypts the document. Call then Save to obtain decrypted version of the document.
    
    Specified by:
    
    decrypt in interface IDocument
  - getPermissions
```
public int getPermissions()
```
    Gets permissions of the document.
    
    Specified by:
    
    getPermissions in interface IDocument
  - isEncrypted
```
public boolean isEncrypted()
```
    Gets encrypted status of the document. True if document is encrypted.
    
    Specified by:
    
    isEncrypted in interface IDocument
  - optimize
```
public 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.
    
    Specified by:
    
    optimize in interface IDocument
  - save
```
public void save()
```
    Save document incrementally (i.e. using incremental update technque). In order to save document incremetally we should open the document file for writing. Therefore Document must be initialized with writable stream like in the next code snippet: Document doc = new Document(new FileStream("document.pdf", FileMode.Open, FileAccess.ReadWrite)); // make some changes and save the document incrementally doc.Save();
    
    Specified by:
    
    save in interface IDocument
  - save
```
public void save(String outputFileName,
        int format)
```
    Saves the document with a new name along with a file format.
    
    Parameters:
    outputFileName - Path to file where the document will be stored.
    format - Format options.
  - save
```
public void save(OutputStream outputStream,
        int format)
```
    Saves the document with a new name along with a file format.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    outputStream - Stream where the document will be stored.
    format - Format options.
    
    Throws:
    
    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.
  - save
```
public void save(String outputFileName,
        SaveOptions options)
```
    Saves the document with a new name setting its save options.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    outputFileName - Path to file where the document will be stored.
    options - Save options.
  - save
```
public void save(OutputStream outputStream,
        SaveOptions options)
```
    Saves the document to a stream with a save options.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    outputStream - Stream where the document will be stored.
    options - Save options.
    
    Throws:
    
    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.
  - getId
```
public Id getId()
```
    Gets the ID.
    
    Specified by:
    
    getId in interface IDocument
  - getMetadataStream
```
public com.aspose.pdf.engine.data.types.IPdfStreamAccessor getMetadataStream()
```
    Returns raw metadata stream
    
    Specified by:
    
    getMetadataStream in interface IDocument
    
    Returns:
    Metadata stream.
  - suppressUpdate
```
public void suppressUpdate()
```
    Suppresses update contents data for all pages The contents is not updated until ResumeUpdate is called
    
    Specified by:
    
    suppressUpdate in interface IDocument
  - resumeUpdate
```
public void resumeUpdate()
```
    resumes document update
    
    Specified by:
    
    resumeUpdate in interface IDocument
  - dispose
```
public void dispose()
```
    Closes all resources used by this document.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
    
    Specified by:
    
    dispose in interface IDocument
  - getBackground
```
public Color getBackground()
```
    Gets the background color of the document.
    
    Specified by:
    
    getBackground in interface IDocument
  - setBackground
```
public void setBackground(Color value)
```
    Sets the background color of the document.
    
    Specified by:
    
    setBackground in interface IDocument
  - getDefaultCopier
```
public Copier getDefaultCopier()
```
    Returns copier used for coping pages to this document.
    
    Specified by:
    
    getDefaultCopier in interface IDocument
  - optimizeResources
```
public 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.
    
    Specified by:
    
    optimizeResources in interface IDocument
  - optimizeResources
```
public void optimizeResources(Document.OptimizationOptions strategy)
```
    Optimize resources in the document according to defined optimization strategy.
    
    Parameters:
    strategy - Optimization strategy.
  - getOptimizeSize
```
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.
    
    Specified by:
    
    getOptimizeSize in interface IDocument
    
    Returns:
    boolean value
  - setOptimizeSize
```
public 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.
    
    Specified by:
    
    setOptimizeSize in interface IDocument
    
    Parameters:
    value - boolean value
  - getIgnoreCorruptedObjects
```
public 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.
    
    Returns:
    boolean value
  - setIgnoreCorruptedObjects
```
public 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.
    
    Parameters:
    value - boolean value
  - getPageLabels
```
public PageLabelCollection getPageLabels()
```
    Gets page labels in the document.
    
    Returns:
    PageLabelCollection Object
  - freeMemory
```
public void freeMemory()
```
    Clears memory
    
    Specified by:
    
    freeMemory in interface IDocument
  - isLicensed
```
public static boolean isLicensed()
```
    Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.
    
    Returns:
    boolean value
  - startOperation
```
public static void startOperation()
```
  - endOperation
```
public static void endOperation()
```
  - isPdfaCompliant
```
public boolean isPdfaCompliant()
```
  - getPdfaFormat
```
public int getPdfaFormat()
```
  - preSave
```
public static void preSave(PageCollection pages)
```
  - getEmbedStandardFonts
```
public 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.
    
    Specified by:
    
    getEmbedStandardFonts in interface IDocument
    
    Returns:
    boolean value
  - setEmbedStandardFonts
```
public 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.
    
    Specified by:
    
    setEmbedStandardFonts in interface IDocument
    
    Parameters:
    value - boolean value
  - save
```
public void save(com.aspose.ms.System.IO.FileStream output)
```
    Specified by:
    
    save in interface IDocument
  - validate
```
public boolean validate(OutputStream outputLogStream,
               int format)
```
  - updatePages
```
public void updatePages()
```
    Specified by:
    
    updatePages in interface IDocument
  - close
```
public void close()
```
    Closes all resources used by this document.
  - getNamedDestinations
```
public NamedDestinationCollection getNamedDestinations()
```
    Collection of Named Destination in the document.
    
    Specified by:
    
    getNamedDestinations in interface IDocument
    
    Returns:
    NamedDestinationCollection instance

Class Document

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.aspose.pdf.IDocument

Field Detail

FontSubstitution

Constructor Detail

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Method Detail

getLocalFontPaths

addLocalFontPath

setLocalFontPaths

restoreLocalFontPath

getPageInfo

setPageInfo

getFontReplaceBehavior

setFontReplaceBehavior

getDestinations

getCollection

setCollection

getEngineDoc

getVersion

getOpenAction

setOpenAction

getHideToolBar

setHideToolBar

getHideMenubar

setHideMenubar

getHideWindowUI

setHideWindowUI

getFitWindow

setFitWindow

getCenterWindow

setCenterWindow

getDisplayDocTitle

setDisplayDocTitle

getPages

getOutlines

getActions

getForm

getEmbeddedFiles

getDirection

setDirection

getPageMode

setPageMode

getNonFullScreenPageMode

setNonFullScreenPageMode

getPageLayout

setPageLayout

getFileName

getInfo

getMetadata

getLogicalStructure

processParagraphs

saveInternal

save

save

exportAnnotationsToXfdf

sendTo

sendTo

sendTo

sendTo

removeMetadata

importAnnotationsFromXfdf

validate

convert