Packages

com.aspose.note

Interfaces

Classes

java.lang.Object
- com.aspose.note.Node
- - com.aspose.note.CompositeNodeBase
  - - com.aspose.note.CompositeNode<Page>
    - - com.aspose.note.Document

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<Page>, com.aspose.ms.System.Collections.IEnumerable<Page>, ICompositeNode, INode, INotebookChildNode, Iterable<Page>
```
public class Document
extends CompositeNode<Page>
implements INotebookChildNode
```
Represents an Aspose.Note document.

Constructor Summary

Constructors
Constructor and Description
`Document()` Initializes a new instance of the `Document` class.
`Document(InputStream inStream)` Initializes a new instance of the `Document` class.
`Document(InputStream inStream, LoadOptions loadOptions)` Initializes a new instance of the `Document` class.
`Document(String filePath)` Initializes a new instance of the `Document` class.
`Document(String filePath, LoadOptions loadOptions)` Initializes a new instance of the `Document` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(DocumentVisitor visitor)` Accepts the visitor of the node.
`void`	`detectLayoutChanges()` Detects all changes made to the document layout since the previous `DetectLayoutChanges` call.
`boolean`	`getAutomaticLayoutChangesDetectionEnabled()` Gets a value indicating whether Aspose.Note performs detection of layout changes automatically.
`Color`	`getColor()` Gets the color.
`Date`	`getCreationTime()` Gets the creation time.
`String`	`getDisplayName()` Gets the display name.
`int`	`getFileFormat()` Gets file format (OneNote 2010, OneNote Online).
`UUID`	`getGuid()` Gets the object's globally unique id.
`com.aspose.ms.System.Guid`	`getGuidInternal()`
`PageHistory`	`getPageHistory(Page page)` Gets the `PageHistory` which contains full history for each page presented in a document (the earliest at index 0).
`void`	`print()` Prints the document using the default printer.
`void`	`print(AttributeSet printSettings)` Prints the document using the default printer.
`void`	`print(PrintOptions options)` Prints the document using the default printer.
`void`	`print(String printerName)` Prints the document using the default printer.
`void`	`save(OutputStream stream)` Saves the OneNote document to a stream.
`void`	`save(OutputStream stream, int format)` Saves the OneNote document to a stream in the specified format.
`void`	`save(OutputStream stream, SaveOptions options)` Saves the OneNote document to a stream using the specified save options.
`void`	`save(String fileName)` Saves the OneNote document to a file.
`void`	`save(String fileName, int format)` Saves the OneNote document to a file in the specified format.
`void`	`save(String fileName, SaveOptions options)` Saves the OneNote document to a file using the specified save options.
`void`	`setAutomaticLayoutChangesDetectionEnabled(boolean value)` Sets a value indicating whether Aspose.Note performs detection of layout changes automatically.
`void`	`setColor(Color value)` Sets the color.
`void`	`setCreationTime(Date value)` Sets the creation time.
`void`	`setDisplayName(String value)` Sets the display name.

Methods inherited from class com.aspose.note.CompositeNode
appendChildFirst, appendChildLast, getChildNodes, getChildren, getFirstChild, getLastChild, getText, insertChild, insertChildrenRange, insertChildrenRange, isComposite, iterator, removeChild

Methods inherited from class com.aspose.note.Node
getDocument, getNextSibling, getNodeType, getParentNode, getPreviousSibling

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Document
```
public Document()
```
    Initializes a new instance of the Document class. Creates a blank OneNote document.
  - Document
```
public Document(String filePath)
```
    Initializes a new instance of the Document class. Opens an existing OneNote document from a file.
    
    Parameters:
    
    filePath - The file path.
    
    Throws:
    
    com.aspose.note.infrastructure.UnsupportedFileFormatException - The document format is not recognized or not supported.
    
    com.aspose.note.infrastructure.FileCorruptedException - The document appears to be corrupted and cannot be loaded.
    
    com.aspose.note.infrastructure.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.
    
    com.aspose.ms.System.InvalidOperationException - There is a problem with the document and it should be reported to Aspose.Note developers.
    
    IOException - There is an input/output exception.
  - Document
```
public Document(String filePath,
                LoadOptions loadOptions)
```
    Initializes a new instance of the Document class. Opens an existing OneNote document from a file. Allows to specify additional options such as an encryption password.
    
    Parameters:
    
    filePath - The file path.
    
    loadOptions - Options used to load a document. Can be null.
    
    Throws:
    
    com.aspose.note.infrastructure.UnsupportedFileFormatException - The document format is not recognized or not supported.
    
    com.aspose.note.infrastructure.FileCorruptedException - The document appears to be corrupted and cannot be loaded.
    
    com.aspose.note.infrastructure.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.
    
    com.aspose.ms.System.InvalidOperationException - There is a problem with the document and it should be reported to Aspose.Note developers.
    
    IOException - There is an input/output exception.
  - Document
```
public Document(InputStream inStream)
```
    Initializes a new instance of the Document class. Opens an existing OneNote document from a stream.
    
    Parameters:
    
    inStream - The stream.
    
    Throws:
    
    com.aspose.note.infrastructure.UnsupportedFileFormatException - The document format is not recognized or not supported.
    
    com.aspose.note.infrastructure.FileCorruptedException - The document appears to be corrupted and cannot be loaded.
    
    com.aspose.note.infrastructure.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.
    
    com.aspose.ms.System.InvalidOperationException - There is a problem with the document and it should be reported to Aspose.Note developers.
    
    IOException - There is an input/output exception.
    
    com.aspose.ms.System.ArgumentException - The stream does not support reading, is null, or is already closed.
  - Document
```
public Document(InputStream inStream,
                LoadOptions loadOptions)
```
    Initializes a new instance of the Document class. Opens an existing OneNote document from a stream. Allows to specify additional options such as an encryption password.
    
    Parameters:
    
    inStream - The stream.
    
    loadOptions - Options used to load a document. Can be null.
    
    Throws:
    
    com.aspose.note.infrastructure.UnsupportedFileFormatException - The document format is not recognized or not supported.
    
    com.aspose.note.infrastructure.FileCorruptedException - The document appears to be corrupted and cannot be loaded.
    
    com.aspose.note.infrastructure.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.
    
    com.aspose.ms.System.InvalidOperationException - There is a problem with the document and it should be reported to Aspose.Note developers.
    
    IOException - There is an input/output exception.
    
    com.aspose.ms.System.ArgumentException - The stream does not support reading, is null, or is already closed.
- Method Detail
  - getAutomaticLayoutChangesDetectionEnabled
```
public boolean getAutomaticLayoutChangesDetectionEnabled()
```
    Gets a value indicating whether Aspose.Note performs detection of layout changes automatically. Default value is true.
  - setAutomaticLayoutChangesDetectionEnabled
```
public void setAutomaticLayoutChangesDetectionEnabled(boolean value)
```
    Sets a value indicating whether Aspose.Note performs detection of layout changes automatically.
    
    Parameters:
    
    value - New value. Can be null.
  - getCreationTime
```
public Date getCreationTime()
```
    Gets the creation time.
  - setCreationTime
```
public void setCreationTime(Date value)
```
    Sets the creation time.
    
    Parameters:
    
    value - DateTime's value.
  - getColor
```
public Color getColor()
```
    Gets the color.
    
    Specified by:
    
    getColor in interface INotebookChildNode
  - setColor
```
public void setColor(Color value)
```
    Sets the color.
    
    Parameters:
    
    value - Color's value.
  - getDisplayName
```
public String getDisplayName()
```
    Gets the display name.
    
    Specified by:
    
    getDisplayName in interface INotebookChildNode
  - setDisplayName
```
public void setDisplayName(String value)
```
    Sets the display name.
    
    Parameters:
    
    value - DateTime's value.
  - getGuid
```
public UUID getGuid()
```
    Gets the object's globally unique id.
    
    Specified by:
    
    getGuid in interface INotebookChildNode
  - getGuidInternal
```
public com.aspose.ms.System.Guid getGuidInternal()
```
    Specified by:
    
    getGuidInternal in interface INotebookChildNode
  - getFileFormat
```
public int getFileFormat()
```
    Gets file format (OneNote 2010, OneNote Online).
  - accept
```
public void accept(DocumentVisitor visitor)
```
    Accepts the visitor of the node.
    
    Specified by:
    
    accept in interface INode
    
    Overrides:
    
    accept in class CompositeNode<Page>
    
    Parameters:
    
    visitor - The object of a class derived from the DocumentVisitor.
  - getPageHistory
```
public PageHistory getPageHistory(Page page)
```
    Gets the PageHistory which contains full history for each page presented in a document (the earliest at index 0). The current page revision can be accessed as PageHistory.current and contained separately from collection of historical versions.
    
    Parameters:
    
    page - The current revision of a page.
    
    Returns:
    
    The PageHistory.
  - save
```
public void save(String fileName)
          throws IOException
```
    Saves the OneNote document to a file.
    
    Parameters:
    
    fileName - The full name for the file. If a file with the specified full name already exists, the existing file is overwritten.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - save
```
public void save(OutputStream stream)
          throws IOException
```
    Saves the OneNote document to a stream.
    
    Parameters:
    
    stream - The System.iO.stream where the document will be saved.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - save
```
public void save(String fileName,
                 int format)
          throws IOException
```
    Saves the OneNote document to a file in the specified format.
    
    Parameters:
    
    fileName - The full name for the file. If a file with the specified full name already exists, the existing file is overwritten.
    
    format - The format in which to save the document.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - save
```
public void save(OutputStream stream,
                 int format)
          throws IOException
```
    Saves the OneNote document to a stream in the specified format.
    
    Parameters:
    
    stream - The System.iO.stream where the document will be saved.
    
    format - The format in which to save the document.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - save
```
public void save(String fileName,
                 SaveOptions options)
          throws IOException
```
    Saves the OneNote document to a file using the specified save options.
    
    Parameters:
    
    fileName - The full name for the file. If a file with the specified full name already exists, the existing file is overwritten.
    
    options - Specifies the options how the document is saved in file.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - save
```
public void save(OutputStream stream,
                 SaveOptions options)
          throws IOException
```
    Saves the OneNote document to a stream using the specified save options.
    
    Parameters:
    
    stream - The System.iO.stream where the document will be saved.
    
    options - Specifies the options how the document is saved in stream.
    
    Throws:
    
    com.aspose.note.infrastructure.IncorrectDocumentStructureException - The document structure violates specification.
    
    com.aspose.note.infrastructure.UnsupportedSaveFormatException - Requested save format is not supported.
    
    IOException
  - print
```
public void print()
           throws PrintException
```
    Prints the document using the default printer.
    
    Throws:
    
    PrintException
  - print
```
public void print(String printerName)
           throws PrintException
```
    Prints the document using the default printer.
    
    Throws:
    
    PrintException
  - print
```
public void print(AttributeSet printSettings)
           throws PrintException
```
    Prints the document using the default printer.
    
    Throws:
    
    PrintException
  - print
```
public void print(PrintOptions options)
           throws PrintException
```
    Prints the document using the default printer.
    
    Parameters:
    
    options - Options used to print a document. Can be null.
    
    Throws:
    
    PrintException
  - detectLayoutChanges
```
public void detectLayoutChanges()
```
    Detects all changes made to the document layout since the previous DetectLayoutChanges call. In case AutomaticLayoutChangesDetectionEnabled set to true, used automatically in the beginning of document export.

Packages

com.aspose.note

Interfaces

Classes

Class Document

Constructor Summary

Method Summary

Methods inherited from class com.aspose.note.CompositeNode

Methods inherited from class com.aspose.note.Node

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Document

Document

Document

Document

Document

Method Detail

getAutomaticLayoutChangesDetectionEnabled

setAutomaticLayoutChangesDetectionEnabled

getCreationTime

setCreationTime

getColor

setColor

getDisplayName

setDisplayName

getGuid

getGuidInternal

getFileFormat

accept

getPageHistory

save

save

save

save

save

save

print

print

print

print

detectLayoutChanges