DocumentWeb (aspose.pdf 16.12.0 API)

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

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IDocument
```
public final class DocumentWeb
extends Object
implements IDocument
```
Represents DocumentWeb class

Nested Class Summary

Nested Classes
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.CallBackGetHocr` The call back procedure for hocr recognize.
`static class`	`com.aspose.pdf.ADocument.FontSubstitutionHandler` It represents class with abstract method that usually supplied by information about missing font while processing documents.

Field Summary

Fields
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 Summary

Constructors
Constructor and Description
`DocumentWeb()` Initializes empty DocumentWeb.
`DocumentWeb(InputStream input)` Initialize new DocumentWeb instance from the `input` stream.
`DocumentWeb(InputStream input, LoadOptions options)` Opens an existing DocumentWeb from a stream providing necessary converting to get pdf DocumentWeb.
`DocumentWeb(InputStream input, String password)`
`DocumentWeb(String filename)` Just init DocumentWeb using `filename`.
`DocumentWeb(String filename, LoadOptions options)`
`DocumentWeb(String filename, String password)` Initializes new instance of the `DocumentWeb` class for working with encrypted DocumentWeb.

Method Summary

Methods
Modifier and Type	Method and Description
`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 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.
`JavaScriptCollection`	`getJavaScript()` Collection of JavaScript of document level.
`RootElement`	`getLogicalStructure()` Gets logical structure of the document.
`Metadata`	`getMetadata()` Document metadata.
`com.aspose.pdf.engine.data.types.IPdfStreamAccessor`	`getMetadataStream()` For internal usage only!
`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 or sets 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 generator.
`void`	`removeMetadata()` Removes metadata from the document.
`void`	`removePdfaCompliance()` Remove pdfa compliance from the document
`void`	`repair()` Repairs broken document.
`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(javax.servlet.http.HttpServletResponse response, String outputFileName, int disposition, SaveOptions options)` Saves the document to a response stream with a save options.
`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)`
`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 substitute)` Setting the flag to replace the missing 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)`
`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.

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

Methods inherited from interface com.aspose.pdf.IDocument
afterImport, bindXml, bindXml, changePasswords, convert, convert, convert, convert, convert, convertInternal, decrypt, dispose, encrypt, encrypt, encrypt, exportAnnotationsToXfdf, flatten, freeMemory, getActions, getBackground, getCatalogValue, getCenterWindow, getCollection, getCryptoAlgorithm, getDefaultCopier, getDestinations, getDirection, getDisplayDocTitle, getEmbeddedFiles, getEmbedStandardFonts, getEngineDoc, getFileName, getFitWindow, getForm, getHideMenubar, getHideToolBar, getHideWindowUI, getId, getIgnoreCorruptedObjects, getInfo, getLogicalStructure, getMetadata, getMetadataStream, getNonFullScreenPageMode, getObjectById, getOpenAction, getOptimizeSize, getOutlines, getPageInfo, getPageLabels, getPageLayout, getPageMode, getPages, getPdfaFormat, getPermissions, getVersion, getXmpMetadata, importAnnotationsFromXfdf, isAbsentFontTryToSubstitute, isEncrypted, isLinearized, isPdfaCompliant, optimize, optimizeResources, optimizeResources, processParagraphs, removeMetadata, removePdfaCompliance, repair, resumeUpdate, save, save, save, save, save, save, save, saveInternal, saveXml, sendTo, sendTo, sendTo, sendTo, setAbsentFontTryToSubstitute, setBackground, setCenterWindow, setCollection, setDirection, setDisplayDocTitle, setEmbedStandardFonts, setFitWindow, setHideMenubar, setHideToolBar, setHideWindowUI, setIgnoreCorruptedObjects, setLayersAdded, setLinearized, setNonFullScreenPageMode, setOpenAction, setOptimizeSize, setPageInfo, setPageLayout, setPageMode, setXmpMetadata, suppressUpdate, updatePages, validate, validate

- Field Detail
  - AbsentFontHandler
```
public com.aspose.pdf.ADocument.AbsentFontHandler AbsentFontHandler
```
    Notification about missing fonts while processing documents.
  - FontSubstitution
```
public final PdfEvent<com.aspose.pdf.ADocument.FontSubstitutionHandler> FontSubstitution
```
    It occurs when font replaces another font in document.
- Constructor Detail
  - DocumentWeb
```
public DocumentWeb()
```
    Initializes empty DocumentWeb.
  - DocumentWeb
```
public DocumentWeb(InputStream input)
```
    Initialize new DocumentWeb instance from the input stream.
    
    Parameters:
    input - Stream with pdf DocumentWeb.
  - DocumentWeb
```
public DocumentWeb(InputStream input,
           String password)
```
  - DocumentWeb
```
public DocumentWeb(InputStream input,
           LoadOptions options)
```
    Opens an existing DocumentWeb from a stream providing necessary converting to get pdf DocumentWeb.
    
    Parameters:
    input - Input stream to convert into pdf DocumentWeb.
    options - Represents properties for converting input into pdf DocumentWeb.
  - DocumentWeb
```
public DocumentWeb(String filename,
           LoadOptions options)
```
  - DocumentWeb
```
public DocumentWeb(String filename)
```
    Just init DocumentWeb using filename. The same as DocumentWeb(Stream).
    
    Parameters:
    filename - The name of the pdf DocumentWeb file.
  - DocumentWeb
```
public DocumentWeb(String filename,
           String password)
```
    Initializes new instance of the DocumentWeb class for working with encrypted DocumentWeb.
    
    Parameters:
    filename - DocumentWeb file name.
    password - User or owner password.
- Method Detail
  - save
```
public void save(javax.servlet.http.HttpServletResponse response,
        String outputFileName,
        int disposition,
        SaveOptions options)
```
    Saves the document to a response stream with a save options.
    
    Parameters:
    response - Encapsulates HTTP-response information.
    outputFileName - Simple file name, i.e. without path.
    disposition - Represents a MIME protocol Content-Disposition header.
    options - Save options.
  - getJavaScript
```
public JavaScriptCollection getJavaScript()
```
    Collection of JavaScript of document level.
  - 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
  - setLayersAdded
```
public void setLayersAdded(boolean value)
```
    Specified by:
    
    setLayersAdded in interface IDocument
  - 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
  - restricted
```
public static boolean restricted(int index)
```
  - cutByRestriction
```
public static void cutByRestriction(Iterable list)
```
  - startOperation
```
public static void startOperation()
```
  - endOperation
```
public static void endOperation()
```
  - isPdfaCompliant
```
public boolean isPdfaCompliant()
```
    Gets the is document pdfa compliant.
    
    Specified by:
    
    isPdfaCompliant in interface IDocument
    
    Returns:
    boolean value
  - getDestinations
```
public DestinationCollection getDestinations()
```
    Gets the collection of destinations.
    
    Specified by:
    
    getDestinations in interface IDocument
    
    Returns:
    DestinationCollection object
  - getPdfaFormat
```
public int getPdfaFormat()
```
    Gets pdfa format.
    
    Specified by:
    
    getPdfaFormat in interface IDocument
    
    Returns:
    PdfFormat
    See Also:
    PdfFormat
  - 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
  - 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
  - removePdfaCompliance
```
public void removePdfaCompliance()
```
    Remove pdfa compliance from the document
    
    Specified by:
    
    removePdfaCompliance in interface IDocument
  - preSave
```
public static void preSave(PageCollection pages)
```
  - getCollection
```
public Collection getCollection()
```
    Gets collection of document.
    
    Specified by:
    
    getCollection in interface IDocument
  - setCollection
```
public void setCollection(Collection value)
```
    Description copied from interface: IDocument
    
    Sets collection of document.
    
    Specified by:
    
    setCollection in interface IDocument
  - getEngineDoc
```
public com.aspose.pdf.engine.IPdfDocument getEngineDoc()
```
    Description copied from interface: IDocument
    
    Instance of IPdfDocument used to access to internal document structure. Internal only
    
    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
    
    Returns:
    boolean value
  - setHideToolBar
```
public void setHideToolBar(boolean value)
```
    Set flag specifying whether toolbar should be hidden when document is active.
    
    Specified by:
    
    setHideToolBar in interface IDocument
    
    Parameters:
    value - boolean value
  - 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
    
    Returns:
    boolean value
  - 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
    
    Parameters:
    value - boolean value
  - 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
    
    Returns:
    boolean value
  - 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
    
    Parameters:
    value - boolean value
  - 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
    
    Returns:
    boolean value
  - 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
    
    Parameters:
    value - boolean value
  - 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
    
    Returns:
    boolean value
  - 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
    
    Parameters:
    value - boolean value
  - 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
    
    Returns:
    boolean value
  - 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
    
    Parameters:
    value - boolean value
  - 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.getPages(); System.out.println("Document contains " + pages.size()); Page page = pages.get_Item(1); Rectangle rect = page.getRect();
    Specified by:
    
    getPages in interface IDocument
    
    Returns:
    boolean value
  - 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.getActions(); com.aspose.pdf.Action afterSavingAction = actions.getAfterSaving();
    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
    
    See Also:
    Direction
  - 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
    
    See Also:
    Direction
  - 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 generator.
    
    Specified by:
    
    processParagraphs in interface IDocument
  - save
```
public void save(OutputStream output)
```
    Stores document into stream.
    
    Specified by:
    
    save in interface IDocument
    
    Parameters:
    output - Stream where document shell be stored.
  - saveInternal
```
public void saveInternal(com.aspose.ms.System.IO.Stream output)
```
    For internal usage only
    
    Specified by:
    
    saveInternal in interface IDocument
    
    Parameters:
    output - For internal usage only
  - 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.
  - save
```
public void save(com.aspose.ms.System.IO.FileStream output)
```
    Specified by:
    
    save in interface IDocument
  - 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 - The pdf format.
    
    Returns:
    The operation result
    See Also:
    PdfFormat
  - convert
```
public boolean convert(String outputLogFileName,
              int format,
              int action,
              int transparencyAction)
```
    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 - The pdf format.
    action - Action for objects that can not be converted
    transparencyAction - Action for image masked objects
    
    Returns:
    The operation result
    See Also:
    PdfFormat, ConvertErrorAction, ConvertTransparencyAction
  - 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 - The pdf format.
    action - Action for objects that can not be converted
    
    Returns:
    The operation result
    See Also:
    PdfFormat, ConvertErrorAction
  - convert
```
public boolean convert(PdfFormatConversionOptions options)
```
    Convert document using specified conversion options
    
    Parameters:
    options - set of options for convert PDF document
    
    Returns:
    The operation result
  - validate
```
public boolean validate(OutputStream outputLogStream,
               int format)
```
    Validate document into the specified file.
    
    Specified by:
    
    validate in interface IDocument
    
    Parameters:
    outputLogStream - Stream where the comments will be stored.
    format - Pdf format.
    
    Returns:
    The operation result
  - validate
```
public boolean validate(PdfFormatConversionOptions options)
```
    Validate document into the specified file.
    
    Parameters:
    options - set of options for convert PDF document
    
    Returns:
    The operation result
  - convert
```
public boolean convert(Document.CallBackGetHocr callback)
```
    Convert document and save errors into the specified file.
    
    Specified by:
    
    convert in interface IDocument
    
    Parameters:
    callback - Action for objects that can not be converted
    
    Returns:
    The operation result
  - convert
```
public boolean convert(Document.CallBackGetHocr callback,
              boolean isTestVisible)
```
    Convert document and save errors into the specified file. This is allow to show/hide searchable text. Default value is FALSE.
    
    Specified by:
    
    convert in interface IDocument
    
    Parameters:
    callback - Action for objects that can not be converted
    isTestVisible - boolean value
    
    Returns:
    The operation result
  - 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
    
    Returns:
    The operation result
  - 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
    
    Returns:
    The operation result
    See Also:
    PdfFormat, ConvertErrorAction, PdfFormat, ConvertErrorAction
  - 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
    
    See Also:
    CryptoAlgorithm
  - 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.
    
    Specified by:
    
    encrypt in interface IDocument
    
    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).
    See Also:
    CryptoAlgorithm
  - 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.
    See Also:
    Permissions, CryptoAlgorithm
  - 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.
    
    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.
    usePdf20 - Support for revision 6 (Extension 8).
    See Also:
    Permissions, CryptoAlgorithm
  - 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 or sets a value indicating whether document is linearized.
    
    Specified by:
    
    isLinearized in interface IDocument
  - setLinearized
```
public void setLinearized(boolean value)
```
    Specified by:
    
    setLinearized 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
    
    Returns:
    int value
  - isEncrypted
```
public boolean isEncrypted()
```
    Gets encrypted status of the document. True if document is encrypted.
    
    Specified by:
    
    isEncrypted in interface IDocument
    
    Returns:
    boolean value
  - 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.
    See Also:
    SaveFormat
  - 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.
    See Also:
    SaveFormat
  - 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)
```
    Specified by:
    
    save in interface IDocument
  - getId
```
public Id getId()
```
    Gets the ID.
    
    Specified by:
    
    getId in interface IDocument
  - getMetadataStream
```
public com.aspose.pdf.engine.data.types.IPdfStreamAccessor getMetadataStream()
```
    For internal usage only!
    Returns raw metadata stream
    
    Specified by:
    
    getMetadataStream in interface IDocument
    
    Returns:
    IPdfStreamAccessor object
  - updatePages
```
public void updatePages()
```
    Specified by:
    
    updatePages in interface IDocument
  - 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
  - close
```
public void close()
```
    Closes all resources used by this document.
  - 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.
    
    Specified by:
    
    optimizeResources in interface IDocument
    
    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
  - getAllowReusePageContent
```
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.
    
    Returns:
    value boolean value
  - setAllowReusePageContent
```
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.
    
    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.
    
    Specified by:
    
    getIgnoreCorruptedObjects in interface IDocument
    
    Returns:
    boolean values
  - 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.
    
    Specified by:
    
    setIgnoreCorruptedObjects in interface IDocument
    
    Parameters:
    value - boolean values
  - getCatalogValue
```
public Object getCatalogValue(String key)
```
    Returns item value from catalog dictionary.
    
    Specified by:
    
    getCatalogValue in interface IDocument
    
    Parameters:
    key - The key of item.
    
    Returns:
    Item value - if key was successfully found; otherwise, null.
  - getPageLabels
```
public PageLabelCollection getPageLabels()
```
    Gets page labels in the document.
    
    Specified by:
    
    getPageLabels in interface IDocument
  - freeMemory
```
public void freeMemory()
```
    Clears memory
    
    Specified by:
    
    freeMemory in interface IDocument
  - afterImport
```
public void afterImport()
```
    Enumerate all registered annotations and call AfterImport for each of them. InternalMethod
    
    Specified by:
    
    afterImport in interface IDocument
  - saveXml
```
public void saveXml(String file)
```
    Save document to XML.
    
    Specified by:
    
    saveXml in interface IDocument
    
    Parameters:
    file - The document model xml file
  - getObjectById
```
public Object getObjectById(String id)
```
    Gets a object with specified ID in the document.
    
    Specified by:
    
    getObjectById in interface IDocument
    
    Parameters:
    id - The object id.
    
    Returns:
    The object with specified id. Null if the id is not found.
  - bindXml
```
public void bindXml(String file)
```
    Bind xml to document
    
    Specified by:
    
    bindXml in interface IDocument
    
    Parameters:
    file - The xml file
  - repair
```
public void repair()
```
    Repairs broken document.
    
    Specified by:
    
    repair in interface IDocument
  - bindXml
```
public void bindXml(String xmlFile,
           String xslFile)
```
    Bind xml/xsl to document
    
    Specified by:
    
    bindXml in interface IDocument
    
    Parameters:
    xmlFile - The xml file.
    xslFile - The xsl file if XSLT is used.
  - bindXml
```
public void bindXml(InputStream xmlStream,
           InputStream xslStream)
```
    Bind xml/xsl to document
    
    Parameters:
    xmlStream - The xml stream.
    xslStream - The xsl stream if XSLT is used.
  - getXmpMetadata
```
public void getXmpMetadata(OutputStream output)
```
    Get XMP metadata from document.
    
    Specified by:
    
    getXmpMetadata in interface IDocument
    
    Parameters:
    output - Stream where metadata will be stored.
  - setXmpMetadata
```
public void setXmpMetadata(InputStream stream)
```
    Set XMP metadata of document.
    
    Specified by:
    
    setXmpMetadata in interface IDocument
    
    Parameters:
    stream - Stream which contains XMP metadata.
  - getEnableObjectUnload
```
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.
    
    Returns:
    boolean value
  - setEnableObjectUnload
```
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.
    
    Parameters:
    value - boolean value
  - isAbsentFontTryToSubstitute
```
public boolean isAbsentFontTryToSubstitute()
```
    Flag which informs about replacement of missing font.
    
    Specified by:
    
    isAbsentFontTryToSubstitute in interface IDocument
  - setAbsentFontTryToSubstitute
```
public void setAbsentFontTryToSubstitute(boolean substitute)
```
    Setting the flag to replace the missing font.
    
    Specified by:
    
    setAbsentFontTryToSubstitute in interface IDocument

Class DocumentWeb

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

AbsentFontHandler

FontSubstitution

Constructor Detail

DocumentWeb

DocumentWeb

DocumentWeb

DocumentWeb

DocumentWeb

DocumentWeb

DocumentWeb

Method Detail

save

getJavaScript

isLicensed

setLayersAdded

getPageInfo

setPageInfo

restricted

cutByRestriction

startOperation

endOperation

isPdfaCompliant

getDestinations

getPdfaFormat

getEmbedStandardFonts

setEmbedStandardFonts

removePdfaCompliance

preSave

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

save

saveInternal

save

save

exportAnnotationsToXfdf

sendTo

sendTo

sendTo