Load OneNote Document or File in Java API

Loading OneNote Documents

The Document class exposed by the OneNote Java API or library can be used to load Microsoft OneNote .One file format files. The following sample code in Java programming language shows the usage of this class for loading a Microsoft OneNote document.

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
        
System.out.println(oneFile.getFileFormat());

Increase Performance for Consequent Export Operations

Aspose.Note API allows increasing performance for consequent export operations. Users may involve in multiple conversions to several supported formats. In such scenarios, the performance is the highly affecting factor.

Aspose.Note for Java offers the Document class that represents a OneNote file. The Document class exposes the AutomaticLayoutChangesDetectionEnabled property and DetectLayoutChanges method, their combined use enable users to disable automatic detection of layout changes and handle them manually:

String dataDir = Utils.getSharedDataDir(OptimizePerformanceForConsequentExportOperations.class) + "load/";
// initialize the new Document
Document doc = new Document();
doc.setAutomaticLayoutChangesDetectionEnabled(false);
// initialize the new Page
Page page = new Page(doc);
// default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle();

textStyle.setFontColor(Color.BLACK);
textStyle.setFontName("Arial");
textStyle.setFontSize(10);

// title text
RichText titleText = new RichText(doc);
titleText.setText("Title text.");
titleText.setParagraphStyle(textStyle);

// title date
RichText titleDate = new RichText(doc);
titleDate.setText("2011,11,11");
titleDate.setParagraphStyle(textStyle);

// title time
RichText titleTime = new RichText(doc);
titleTime.setText("12:34");
titleTime.setParagraphStyle(textStyle);

Title title = new Title(doc);
title.setTitleText(titleText);
title.setTitleDate(titleDate);
title.setTitleTime(titleTime);
page.setTitle(title);

// append page node
doc.appendChildLast(page);
// save OneNote document in the HTML format
try {
	doc.save(dataDir + "OptimizePerformanceForConsequentExportOperations_out.html");
} catch (Exception e) {
	// TODO Auto-generated catch block
	// e.printStackTrace();
	System.out.println("Saving as Html: " + e.getMessage());
}
// save OneNote document in the PDF format
try {
	doc.save(dataDir + "OptimizePerformanceForConsequentExportOperations_out.pdf");
} catch (Exception e) {
	// TODO Auto-generated catch block
	// e.printStackTrace();
	System.out.println("Saving as PDF: " + e.getMessage());
}
// save OneNote document in the JPG format
try {
	doc.save(dataDir + "OptimizePerformanceForConsequentExportOperations_out.jpg");
} catch (Exception e) {
	// TODO Auto-generated catch block
	// e.printStackTrace();
	System.out.println("Saving as JPG: " + e.getMessage());
}
// set text font size
textStyle.setFontSize(11);
// detect layout changes manually
doc.detectLayoutChanges();
// save OneNote document in the BMP format
try {
	doc.save(dataDir + "OptimizePerformanceForConsequentExportOperations_out.bmp");
} catch (Exception e) {
	// TODO Auto-generated catch block
	// e.printStackTrace();
	System.out.println("Saving as bmp: " + e.getMessage());
}

Working with Password Protected OneNote Documents

Aspose.Note API allows to load password-protected OneNote documents. The API’s LoadOptions class provides the setDocumentPassword method to specify the document password.

Creating Password Protected OneNote Documents

Aspose.Note API allows to set password for the document while saving OneNote documents. The setDocumentPassword method exposed by OneSaveOptions class provides the capability to password protect a document.

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

Document document = new Document(dataDir + "Sample1.one");

OneSaveOptions saveOptions = new OneSaveOptions();

saveOptions.setDocumentPassword("pass");

document.save(dataDir + "CreatePasswordProtected_out.one", saveOptions);

Loading Password Protected OneNote Documents

A password-protected OneNote document can be loaded using the following steps:

1. Create a new object of LoadOptions class
2. Specify the password of the document using the setDocumentPassword method
3. Load the document with the defined object of the LoadOptions class

String dataDir = Utils.getSharedDataDir(LoadPasswordProtectedOneNoteDoc.class) + "load/";

LoadOptions loadOptions = new LoadOptions();

loadOptions.setDocumentPassword("password");

Document doc = new Document(dataDir + "Sample1.one", loadOptions);
		
System.out.println(doc.getFileFormat());

        String dataDir = Paths.get(Utils.getSharedDataDir(LoadPasswordProtectedOneNoteDoc.class), "load").toString();

        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setDocumentPassword("password");

        FileInputStream stream = new FileInputStream(Paths.get(dataDir, "Sample1.one").toString());

        try {
            Document ref[] = { null };
            if (!Document.isEncrypted(stream, loadOptions, ref))
            {
                System.out.println("The document is loaded and ready to be processed.");
            }
            else
            {
                System.out.println("The document is encrypted. Provide a password.");
            }
        }
        finally {
            stream.close();
        }

        String dataDir = Paths.get(Utils.getSharedDataDir(LoadPasswordProtectedOneNoteDoc.class), "load").toString();

        Document ref[] = { null };
        if (!Document.isEncrypted(Paths.get(dataDir, "Sample1.one").toString(), "VerySecretPassword", ref))
        {
            if (ref[0] != null)
            {
                System.out.println("The document is decrypted. It is loaded and ready to be processed.");
            }
            else
            {
                System.out.println("The document is encrypted. Invalid password was provided.");
            }
        }
        else
        {
            System.out.println("The document is NOT encrypted. It is loaded and ready to be processed.");
        }

Setting Page Splitting Algorithm

While converting a OneNote document to other formats, images and other contents may get disturbed due to their position in the document. Thus, it is necessary to specify some methods to split a page. The PdfSaveOptions.PageSplittingAlgorithm property provides different options to specify an algorithm of page splitting. These options are:

• AlwaysSplitObjectsAlgorithm - Splits objects into several parts at pages’ bottom position.
• KeepPartAndCloneSolidObjectToNextPageAlgorithm - Adds objects up to the bottom of the page and clone full object to the next page in case it doesn’t fit in the original page.
• KeepSolidObjectsAlgorithm - Shifts full object to the next page in case it doesn’t fit in the original page.

The default algorithm is KeepSolidObjectsAlgorithm.

Using the Splitting Algorithm Method

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java

String inputFile = "Sample1.one";
Path inputPath = Utils.getPath(UsingSplittingAlgorithmMethod.class, inputFile);

String outputFile = "output.Jpeg";
Path outputPath = Utils.getPath(UsingSplittingAlgorithmMethod.class, outputFile);

Document doc = new Document(inputPath.toString());

PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.setPageSplittingAlgorithm(new AlwaysSplitObjectsAlgorithm());
// or
pdfSaveOptions.setPageSplittingAlgorithm(new KeepPartAndCloneSolidObjectToNextPageAlgorithm());
// or
pdfSaveOptions.setPageSplittingAlgorithm(new KeepSolidObjectsAlgorithm());
try {
	doc.save(outputPath.toString(), pdfSaveOptions);
} catch (Exception ex) {
	System.out.println("Exception: " + ex.getMessage());
}

For KeepPartAndCloneSolidObjectToNextPageAlgorithm and KeepSolidObjectsAlgorithm, the maximum possible height of an object plays a role that can be cloned to the next page. In case an object cannot be cloned, it will be split using AlwaysSplitObjectsAlgorithm. Use the constructor parameter to change this limit as shown below:

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java
float heightLimitOfClonedPart = 500;
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions
		.setPageSplittingAlgorithm(new KeepPartAndCloneSolidObjectToNextPageAlgorithm(heightLimitOfClonedPart));
// or
pdfSaveOptions.setPageSplittingAlgorithm(new KeepSolidObjectsAlgorithm(heightLimitOfClonedPart));

KeepSolidObjectsAlgorithm

\1. The limit was exceeded and images were split on the pages joint.

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java
pdfSaveOptions.setPageSplittingAlgorithm(new KeepSolidObjectsAlgorithm(100));

\2. The limit is sufficient and images were completely cloned to the next page.

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java
pdfSaveOptions.setPageSplittingAlgorithm(new KeepSolidObjectsAlgorithm(400));

KeepPartAndCloneSolidObjectToNextPageAlgorithm

\1. The limit was exceeded and images were split into the pages joint.

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java
pdfSaveOptions.setPageSplittingAlgorithm(new KeepPartAndCloneSolidObjectToNextPageAlgorithm(100));

\2. The limit is sufficient and images were partially added to the first page and completely cloned to the next page.

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-Java
pdfSaveOptions.setPageSplittingAlgorithm(new KeepPartAndCloneSolidObjectToNextPageAlgorithm(400));

AlwaysSplitObjectsAlgorithm

Images were split into the pages joint.