Working with Pages

Aspose.Note for Java APIs provide support to get the history of a specific Page, e.g. how many times a page is updated, content tracking changes and much more. All the pages of the OneNote file are contained by page nodes of the Document object.

Get Number of Pages from the OneNote Document

Aspose.Note for Java supports retrieving the number of pages from a OneNote document.

This example work as follows:

1. Create an object of the Document class.
2. Call getChildNodes method of the Document class.
3. Get a list of page nodes.
4. Get the number of pages via Count property.
5. Display the count on the output screen.

The following code snippet shows you how to get the number of pages from a OneNote file

String dataDir = Utils.getSharedDataDir(GetPageCount.class) + "pages/";
// Load the document into Aspose.Note
Document doc = new Document(dataDir + "Sample1.one");

// Get number of pages
int count = doc.getChildNodes(Page.class).size();

// Print page count
System.out.printf("Total Pages: %s", count);

Get Information of Each Page from the OneNote Document

The Page class provides all the properties related to a page of a OneNote document. All the pages of the OneNote file are contained by page nodes of the Document object.

The code below shows how to get information about each page in a OneNote document.

String dataDir = Utils.getSharedDataDir(GetInfo.class) + "pages/";
// Load the document into Aspose.Note
LoadOptions options = new LoadOptions();
Document doc = new Document(dataDir + "Sample1.one", options);

// Get page revisions
List<Page> pages = doc.getChildNodes(Page.class);

// Traverse list of pages
for (Page pageRevision : pages) {
	System.out.println("LastModifiedTime: " + pageRevision.getLastModifiedTime());
	System.out.println("CreationTime: " + pageRevision.getCreationTime());
	System.out.println("Title: " + pageRevision.getTitle());
	System.out.println("Level: " + pageRevision.getLevel());
	System.out.println("Author: " + pageRevision.getAuthor());
}

Create OneNote Document with Root and Sub Level Pages

This article explains how developers can generate OneNote document including various pages at root or sub-level positions. Aspose.Note APIs lets the developer to programmatically choose the level of the page.

Generating Root and Sub Level Pages in OneNote

Please see below a brief description to create a OneNote document using the Aspose.Note APIs:

1. Create an instance of the Document class that represents a OneNote document.
2. Initialize three objects of Page class and set their levels.
3. Initialize separate objects of Outline, OutlineElement and RichText classes for each Page object by passing the Document class object. Calling the AppendChildLast method of the OutlineElement, Outline, Page and Document classes adds an appropriate new node that can be further used to add other nodes to the OneNote document.
4. The TextStyle class defines the text formatting.
5. Generate the OneNote document by calling the Save method of the Document object.

String dataDir = Utils.getSharedDataDir(CreateDocWithRootAndSubPages.class) + "pages/";
		
// create an object of the Document class
Document doc = new Document();
// initialize Page class object and set its level
Page page1 = new Page(doc);
page1.setLevel((byte) 1);
// initialize Page class object and set its level
Page page2 = new Page(doc);
page1.setLevel((byte) 2);
// initialize Page class object and set its level
Page page3 = new Page(doc);
page1.setLevel((byte) 1);

// ---------- Adding nodes to first Page ----------
Outline outline = new Outline(doc);
OutlineElement outlineElem = new OutlineElement(doc);
ParagraphStyle textStyle = new ParagraphStyle();
textStyle.setFontColor(java.awt.Color.black);
textStyle.setFontName("David Transparent");
textStyle.setFontSize(10);

RichText text = new RichText(doc);
text.setText("First page.");
text.setParagraphStyle(textStyle);

outlineElem.appendChildLast(text);
outline.appendChildLast(outlineElem);
page1.appendChildLast(outline);

// ---------- Adding nodes to second Page ----------
Outline outline2 = new Outline(doc);
OutlineElement outlineElem2 = new OutlineElement(doc);
// var textStyle2 = new TextStyle { FontColor = Color.Black, FontName =
// "Arial", FontSize = 10 };
ParagraphStyle textStyle2 = new ParagraphStyle();
textStyle2.setFontColor(java.awt.Color.black);
textStyle2.setFontName("David Transparent");
textStyle2.setFontSize(10);

// var text2 = new RichText(doc) { Text = "Second page.", DefaultStyle =
// textStyle2 };
RichText text2 = new RichText(doc);
text2.setText("Second page.");
text2.setParagraphStyle(textStyle2);

outlineElem2.appendChildLast(text2);
outline2.appendChildLast(outlineElem2);
page2.appendChildLast(outline2);

// ---------- Adding nodes to third Page ----------
Outline outline3 = new Outline(doc);
OutlineElement outlineElem3 = new OutlineElement(doc);
ParagraphStyle textStyle3 = new ParagraphStyle();
textStyle3.setFontColor(java.awt.Color.black);
textStyle3.setFontName("Broadway");
textStyle3.setFontSize(10);

RichText text3 = new RichText(doc);
text3.setText("Third page.");
text3.setParagraphStyle(textStyle3);

outlineElem3.appendChildLast(text3);
outline3.appendChildLast(outlineElem3);
page3.appendChildLast(outline3);

// ---------- Add pages to the OneNote Document ----------
doc.appendChildLast(page1);
doc.appendChildLast(page2);
doc.appendChildLast(page3);

try {
	doc.save(dataDir + "GenerateRootAndSubLevelPagesInOneNote_out.bmp", SaveFormat.Bmp);

} catch (IOException e) {

}

Working with Page Revision Information

// The path to the documents directory.
String dataDir = Utils.getSharedDataDir(WorkingWithPageRevisions.class) + "pages\\";

// Load OneNote document and get first child
Document document = new Document(dataDir + "Sample1.one");
Page page = document.getFirstChild();

// Reading Content Revision Summary for this page
RevisionSummary pageRevisionInfo = page.getPageContentRevisionSummary();

System.out.println(String.format("Author:\t%s\nModified:\t%s",
        pageRevisionInfo.getAuthorMostRecent(),
        pageRevisionInfo.getLastModifiedTime().toString()));

// Update Page Revision Summary for this page
pageRevisionInfo.setAuthorMostRecent("New Author");
Calendar modifiedDate = Calendar.getInstance();
pageRevisionInfo.setLastModifiedTime(modifiedDate.getTime());
document.save(dataDir + "WorkingWithPageRevisions_out.one");

Working with Page History

Get All Revisions of a Specific Page

There is a LoadHistory property of the LoadOptions class which tells whether the document loader should read and parse entire document history. The default value is true. In case of such a file with a huge amount of history data consider using LoadHistory=false, to decrease memory and CPU usage.

The code sample below shows how to get a particular Page and then get its history revisions detail.

String dataDir = Utils.getSharedDataDir(GetPageRevisions.class) + "pages/";

LoadOptions loadOptions = new LoadOptions();
loadOptions.setLoadHistory(true);
// load OneNote document
Document document = new Document(dataDir + "Sample1.one", loadOptions);
// get first page
Page firstPage = document.getFirstChild();
for (Page pageRevision : document.getPageHistory(firstPage)) {
	// Use pageRevision like a regular page.
	System.out.println("LastModifiedTime: " + pageRevision.getLastModifiedTime());
	System.out.println("CreationTime: " + pageRevision.getCreationTime());
	System.out.println("Title: " + pageRevision.getTitle());
	System.out.println("Level: " + pageRevision.getLevel());
	System.out.println("Author: " + pageRevision.getAuthor());
	System.out.println();
}

Roll Back To Previous Page Version

String dataDir = Utils.getSharedDataDir(InsertPages.class) + "pages/";

// Load OneNote document and get first child
Document document = new Document(dataDir + "Sample1.one");

Page page = document.getFirstChild();

PageHistory pageHistory = document.getPageHistory(page);

document.removeChild(page);

document.appendChildLast(pageHistory.get_Item(pageHistory.size() - 1));

document.save(dataDir + "RollBackToPreviousPageVersion_out.one");

Push Current Page Version To History

String dataDir = Utils.getSharedDataDir(InsertPages.class) + "pages/";
// Load OneNote document and get first child
Document document = new Document(dataDir + "Sample1.one");
Page page = document.getFirstChild();

PageHistory pageHistory = document.getPageHistory(page);

pageHistory.addItem(page.deepClone());

document.save(dataDir + "PushCurrentPageVersion_out.one");

Modify Page History

String dataDir = Utils.getSharedDataDir(InsertPages.class) + "pages/";
// Load OneNote document and get first child
Document document = new Document(dataDir + "Sample1.one");

Page page = document.getFirstChild();

PageHistory pageHistory = document.getPageHistory(page);

pageHistory.removeRange(0, 1);

pageHistory.set_Item(0, new Page(document));

pageHistory.get_Item(1).getTitle().getTitleText().setText("New Title");

pageHistory.addItem(new Page(document));

pageHistory.insertItem(1, new Page(document));

document.save(dataDir + "ModifyPageHistory_out.one");

Working with Conflict Pages

A document can have pages with conflict pages in its history. Such pages are not saved to document by default. Aspose.Note API lets you manipulate such a page history using the isConflictPage method of history page as shown below.

String dataDir = Utils.getSharedDataDir(GetInfo.class) + "pages/";
// Load the document into Aspose.Note
LoadOptions options = new LoadOptions();
Document doc = new Document(dataDir + "Aspose.one", options);

DateFormat df = new SimpleDateFormat("dd.MM.yyyy HH.mm.ss");
		
PageHistory history = doc.getPageHistory(doc.getFirstChild());
for (int i = 0; i < history.size(); i++)
{
	Page historyPage = history.get_Item(i);
	System.out.format(" %d. Author: %s, %s",
                  i,
                  historyPage.getPageContentRevisionSummary().getAuthorMostRecent(),
                  df.format(historyPage.getPageContentRevisionSummary().getLastModifiedTime()));
	System.out.println(historyPage.isConflictPage() ? ", IsConflict: true" : "");
    // By default conflict pages are just skipped on saving.
    // If mark it as non-conflict then it will be saved as usual one in the history.
    if (historyPage.isConflictPage())
        historyPage.setConflictPage(false);
}

doc.save(dataDir + "ConflictPageManipulation_out.one", SaveFormat.One);