Working with Attachments

Retrieve Attached Files from a OneNote Document

All files attached to a Microsoft OneNote document can be retrieved. These files are stored in AttachedFile nodes. The AttachedFile class represents an attached file.

A OneNote file displaying attached files

To extract all attached files from a OneNote document, follow these steps:

1. Use the Document.getChildNodes method to select all AttachedFile nodes.
2. Iterate through the resulting node collections.
3. Extract image bytes array using the AttachedFile.Bytes property.
4. Save the attached file bytes to the local space.

This example shows how to extract attached files from a OneNote document and save them to local space.

String dataDir = Utils.getSharedDataDir(RetrieveAttachment.class) + "text/";

// Load the document into Aspose.Note
Document doc = new Document(dataDir + "Sample1.one");

// Get list of attachments
List<AttachedFile> attachments = doc.getChildNodes(AttachedFile.class);
System.out.println("Total attachments: " + attachments.size());

for (AttachedFile a : attachments) {
	// Load attachment into memory
	byte[] buffer = a.getBytes();
	ByteArrayInputStream stream = new ByteArrayInputStream(buffer);

	// Save it to output location
	String outputFile = "Output_" + a.getFileName();
	Path outputPath = Utils.getPath(RetrieveAttachment.class, outputFile);
	Files.copy(stream, outputPath, StandardCopyOption.REPLACE_EXISTING);

	System.out.println("File saved: " + outputPath);
}

Attach a File to the OneNote Document

To keep a copy of any document or file as part of the OneNote document, developers can attach it to the OneNote page. The AttachedFile class represents an attachment file.

To attach a file to a OneNote document, follow these steps:

1. Use the Document class to generate the OneNote file.
2. Initialize Page, OutlineElement and Outline classes by passing document object.
3. Initialize AttachedFile object by passing the document object and file path.
4. Add an attached file node under the OutlineElement node.
5. Save a OneNote document.

Attach File by Passing its Path

This example shows how to attach a file to a OneNote document.

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

// Create an object of the Document class
Document doc = new Document();

// Initialize Page class object
Page page = new Page(doc);

// Initialize Outline class object
Outline outline = new Outline(doc);

// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);

// Initialize AttachedFile class object
AttachedFile attachedFile = new AttachedFile(doc,  dataDir + "attachment.txt");

// Add attached file
outlineElem.appendChildLast(attachedFile);

// Add outline element node
outline.appendChildLast(outlineElem);

// Add outline node
page.appendChildLast(outline);

// Add page node
doc.appendChildLast(page);
dataDir = dataDir + "AttachFileByPath_out.one";
doc.save(dataDir);

Attach File and Set its Icon by Passing Files Path

This example shows how to attach a file and also set an attach file icon in the OneNote document.

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

// Create an object of the Document class
Document doc = new Document();

// Initialize Page class object
Page page = new Page(doc);

// Initialize Outline class object
Outline outline = new Outline(doc);

// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);

// Initialize AttachedFile class object and also pass its icon path
AttachedFile attachedFile = null;
try {
    attachedFile = new AttachedFile(doc, dataDir + "attachment.txt", new FileInputStream(dataDir  + "icon.jpg"), ImageFormat.getJpeg());
} catch (FileNotFoundException e) {
    e.printStackTrace();
}

// Add attached file
outlineElem.appendChildLast(attachedFile);

// Add outline element node
outline.appendChildLast(outlineElem);

// Add outline node
page.appendChildLast(outline);

// Add page node
doc.appendChildLast(page);

dataDir = dataDir + "AttachFileAndSetIcon_out.one";
doc.save(dataDir);