Working with OneNote Notebook

Creating and Saving A Notebook

The Notebook class exposed by the API lets you create a notebook from scratch and save it as OneNote Notebook (.onetoc2). OneNote notebook can be created using the default constructor of Notebook class. This article shows creating and saving a Notebook document.

Saving Notebook to Stream

// Load the document into Aspose.Note.
String dataDir = Utils.getSharedDataDir(SaveNotebooktoStream.class) + "Notebook/";

Notebook notebook = new Notebook();

FileOutputStream stream = new FileOutputStream(dataDir + "output.onetoc2");

notebook.save(stream);

if (notebook.getCount() > 0) {
	Document childDocument0 = (Document) notebook.get_Item(0);

	OutputStream childStream = new FileOutputStream(dataDir + "childStream.one");
	childDocument0.save(childStream);

	Document childDocument1 = (Document) notebook.get_Item(1);

	childDocument1.save(dataDir + "child.one");
}

Support of Password Protected Documents Writing as Part of .onetoc2 Notebook

// Load the document into Aspose.Note.
String dataDir = Utils.getSharedDataDir(WritingPasswordProtectedDoc.class) + "Notebook/";
		
Notebook notebook = new Notebook();
		
NotebookOneSaveOptions saveOptions = new NotebookOneSaveOptions();
saveOptions.setDeferredSaving(true);
notebook.save(dataDir + "Open Notebook.onetoc2", saveOptions);

Document childDocument0 = (Document) notebook.get_Item(0);
childDocument0.save(dataDir + "Not Locked.one");

Document childDocument1 = (Document) notebook.get_Item(1);
OneSaveOptions documentSaveOptions1 = new OneSaveOptions();
documentSaveOptions1.setDocumentPassword("pass1");
childDocument1.save(dataDir + "Locked Pass1.one", documentSaveOptions1);

Document childDocument2 = (Document) notebook.get_Item(2);
OneSaveOptions documentSaveOptions2 = new OneSaveOptions();
documentSaveOptions2.setDocumentPassword("pass2");
childDocument2.save(dataDir + "Locked Pass2.one", documentSaveOptions2);

Reading Notebook File

The Notebook class exposed by the API lets you read a OneNote Notebook (.onetoc2) file from disc. The NotebookLoadOptions class provides further options to load the file with user-specified options.

Loading Notebook File

String dataDir = Utils.getSharedDataDir(LoadingNotebook.class) + "Notebook/";
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");
      
      
for (INotebookChildNode notebookChildNode : notebook) {
	System.out.println(notebookChildNode.getDisplayName());

	if (notebookChildNode instanceof Document) {
		// Do something with child document
	} else if (notebookChildNode instanceof Notebook) {
		// Do something with child notebook
	}
}

Loading Notebook File from Stream

Loading Notebook File with LoadOptions

By default, notebook’s child documents are loaded “lazily”, i.e. their loading is postponed until direct access to a specific child. An alternative approach is to load all children at once. The last can be achieved by passing to the Notebook constructor NotebookLoadOptions with the InstantLoading flag set to true. The following code snippets demonstrate both approaches.

Loading Notebook with Lazy Loading Option

String dataDir = Utils.getSharedDataDir(LoadingNotebookFilewithLoadOptions.class) + "Notebook/";

// By default children loading is "lazy".
Notebook notebook = new Notebook(dataDir + "test.onetoc2");

for (INotebookChildNode notebookChildNode : notebook) {
	// Actual loading of the child document happens only here.
	if (notebookChildNode instanceof Document) {
		// Do something with child document
	}
}

Loading Notebook Instantly

// By default children loading is "lazy".
// Therefore for instant loading has took place,
// it is necessary to set the NotebookLoadOptions.InstantLoading flag.
NotebookLoadOptions loadOptions = new NotebookLoadOptions();
loadOptions.setInstantLoading(true);
String dataDir = Utils.getSharedDataDir(LoadingNotebookInstantly.class) + "Notebook/";
Notebook notebook = new Notebook(dataDir + "test.onetoc2", loadOptions);

// All child documents are already loaded.
for (INotebookChildNode notebookChildNode : notebook) {
	if (notebookChildNode instanceof Document) {
		// Do something with child document
	}
}

In the current implementation, lazy loading implemented only for OneNote 2010 child documents/notebooks. OneNote Online first-level child documents/notebooks are always loaded instantly.

For instance, if there is a hierarchy structure:

• Root Notebook (2010)

— Section 1 Level 1 (2010)

— Section 2 Level 1 (Online)

— Notebook 1 Level 1 (2010)

—– Section 1 Level 2 (Online)

— Notebook 2 Level 1 (Online)

—– Section 1 Level 2 (Online)

—– Section 2 Level 2 (2010)

Then the only children will be loaded instantly are: Root Notebook -> Section 2 Level 1, Root Notebook -> Notebook 2 Level 1 and Root Notebook -> Notebook 2 Level 1 -> Section 1 Level 2.

Note that “Root Notebook -> Notebook 1 Level 1 -> Section 1 Level 2” is not loaded at the same time as “Root Notebook”; instead it will be loaded instantly while “Root Notebook -> Notebook 1 Level 1” is loading, as it is the first-level child for the mentioned notebook and the last is not Online itself.

Loading Password Protected Documents as a part of .onetoc2 Notebook

A password-protected notebook can be loaded with the help of LoadOptions class of the API specifying the password.

// Load the document into Aspose.Note.
String dataDir = Utils.getSharedDataDir(LoadPasswordProtectedDocuments.class) + "Notebook/";
		
NotebookLoadOptions loadOptions = new NotebookLoadOptions();
loadOptions.setDeferredLoading(true);
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2", loadOptions);

notebook.loadChildDocument(dataDir + "Neuer Abschnitt 1.one");

LoadOptions documentLoadOptions1 = new LoadOptions();
documentLoadOptions1.setDocumentPassword("pass");
notebook.loadChildDocument(dataDir + "Locked Pass1.one", documentLoadOptions1);

LoadOptions documentLoadOptions2 = new LoadOptions();
documentLoadOptions2.setDocumentPassword("pass");
notebook.loadChildDocument(dataDir + "Locked Pass2.one", documentLoadOptions2);

Adding a Child Node to OneNote Notebook

Aspose.Note API lets you add/append a child node to a OneNote Notebook. The appendChildLast method exposed by the Notebook class allows you to achieve this.

String dataDir = Utils.getSharedDataDir(AddChildNode.class) + "Notebook/";
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Append a new child to the Notebook
notebook.appendChild(new Document(dataDir + "Neuer Abschnitt 1.one"));

dataDir = dataDir + "AddChildNodetoOneNoteNotebook_out.onetoc2";

// Save the Notebook
notebook.save(dataDir);

Remove a Child Node From OneNote Notebook

Aspose.Note API provides the capability to remove a child node from OneNote notebook. The removeChild method exposed by the API’s Notebook class lets you remove a child node that is meant to be removed from the Notebook.

String dataDir = Utils.getSharedDataDir(RemoveChildNode.class) + "Notebook/";
		
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "test.onetoc2");

// Traverse through its child nodes for searching the desired child item
for (INotebookChildNode child : new List<>(notebook))
{
    if (child.getDisplayName() == "Remove Me")
    {
        // Remove the Child Item from the Notebook
        notebook.removeChild(child);
    }
}

dataDir = dataDir + "RemoveChildNodeFromOneNoteNotebook_out.onetoc2";

// Save the Notebook
notebook.save(dataDir);

Converting Notebook Document to Image

Aspose.Note API provides the capability to convert Notebook documents (.onetoc2) to image. The API can export the document to image directly or we can also specify additional save options using the NotebookImageSaveOptions class. This article shows all the approaches to export Notebook to the image.

Exporting Notebook to Image

String dataDir = Utils.getSharedDataDir(ConvertToImage.class) + "Notebook/";
		
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ExportNotebooktoImage_out.png";
		
// Save the Notebook
notebook.save(dataDir);

Exporting Notebook to Image with Options

String dataDir = Utils.getSharedDataDir(ConvertToImageWithOptions.class) + "Notebook/";
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "test.onetoc2");

NotebookImageSaveOptions notebookSaveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

ImageSaveOptions documentSaveOptions = notebookSaveOptions.getDocumentSaveOptions();

documentSaveOptions.setResolution(400);

dataDir = dataDir + "ExportNotebooktoImagewithOptions_out.png";

// Save the Notebook
notebook.save(dataDir, notebookSaveOptions);

Export to Image as a Flattened Notebook

String dataDir = Utils.getSharedDataDir(ConvertToImageAsFlattenedNotebook.class) + "Notebook/";
		
Notebook notebook = new Notebook(dataDir + "test.onetoc2");

NotebookImageSaveOptions saveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

ImageSaveOptions documentSaveOptions = saveOptions.getDocumentSaveOptions();

documentSaveOptions.setResolution(400);

saveOptions.setFlatten(true);

notebook.save(dataDir + "ExportImageasFlattenedNotebook_out.png", saveOptions);

Converting Notebook Document to PDF

Aspose.Note API provides the capability to convert Notebook documents (.onetoc2) to PDF format. The API can export the document to PDF directly or we can also specify additional save options using the NotebookPdfSaveOptions class. This article shows all the approaches to export Notebook to PDF.

Please note that you cannot set values against the Application and Producer fields, because of Aspose Ltd. and Aspose.Note for Java x.x will be displayed against these fields.

Exporting Notebook to PDF

String dataDir = Utils.getSharedDataDir(ConvertToPDF.class) + "Notebook/";
		
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ExportNotebooktoPDF_out.pdf";

// Save the Notebook
notebook.save(dataDir);

Exporting Notebook to PDF with Options

String dataDir = Utils.getSharedDataDir(ConvertToPDFWithOptions.class) + "Notebook/";
		
// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

NotebookPdfSaveOptions notebookSaveOptions = new NotebookPdfSaveOptions();

PdfSaveOptions documentSaveOptions = notebookSaveOptions.getDocumentSaveOptions();

documentSaveOptions.setPageSplittingAlgorithm (new KeepSolidObjectsAlgorithm());

dataDir = dataDir + "ExportNotebooktoPDFwithOptions_out.pdf";

// Save the Notebook
notebook.save(dataDir, notebookSaveOptions);

Export to PDF as a Flattened Notebook

Aspose.Note API can be used to export a OneNote notebook as a Flattened PDF which exports all children to a single directory.

String dataDir = Utils.getSharedDataDir(ExportNotebookToPDFAsFlattened.class) + "Notebook/";

// Load a OneNote Notebook
Notebook notebook = new Notebook(dataDir + "Notizbuch îffnen.onetoc2");

NotebookPdfSaveOptions notebookSaveOptions = new NotebookPdfSaveOptions();

notebookSaveOptions.setFlatten(true);

dataDir = dataDir + "ExportNotebookToPDFAsFlattened_out.pdf";

// Save the Notebook
notebook.save(dataDir, notebookSaveOptions);

Retrieve Documents from OneNote Notebook

The following code snippet demonstrates how to get all documents which are presented in the entire MS OneNote notebook including child notebooks.

String dataDir = Utils.getSharedDataDir(RetrieveDocumentsfromOneNoteNotebook.class) + "Notebook/";
Notebook rootNotebook = new Notebook(dataDir + "test.onetoc2");

List<Document> allDocuments = rootNotebook.getChildNodes(Document.class);
for (Document document : allDocuments) {
	System.out.println(document.getDisplayName());
}

Read RichText Nodes from Microsoft OneNote Notebook

The following code snippet demonstrates how to print all RichText nodes from MS OneNote notebook:

String dataDir = Utils.getSharedDataDir(LoadingNotebook.class) + "Notebook/";
Notebook rootNotebook = new Notebook(dataDir + "test.onetoc2");

List<RichText> allRichTextNodes = rootNotebook.getChildNodes(RichText.class);
for (RichText richTextNode : allRichTextNodes) {
	System.out.println(richTextNode.getText());
}