Work or Extract Images from OneNote Document using C#

Extract Images from a OneNote Document

All images are stored inside image nodes in a OneNote document.

Extract Images

To extract all images or from a OneNote document, follow these steps:

1. Use the Document.GetChildNodes method to select all Image nodes.
2. Iterate through the resulting Image node collections.
3. Extract image bytes array using the Image.Bytes property.
4. Save image bytes to a file.

The code example given below demonstrates how to extract images from a OneNote document and save them as files.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

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

// Get all Image nodes
IList<Aspose.Note.Image> nodes = oneFile.GetChildNodes<Aspose.Note.Image>();

foreach (Aspose.Note.Image image in nodes)
{
    using (MemoryStream stream = new MemoryStream(image.Bytes))
    {
        using (Bitmap bitMap = new Bitmap(stream))
        {
            // Save image bytes to a file
            bitMap.Save(String.Format(dataDir + "{0}", Path.GetFileName(image.FileName)));
        }
    }
}

Get Information of Each Image from the OneNote Document

The Image class provides all the image properties for images in OneNote documents. All the images of the OneNote file are contained by image nodes in the Document object.

Get Information

The code example given below demonstrates how to get information about each image from a OneNote document.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

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

// Get all Image nodes
IList<Aspose.Note.Image> images = oneFile.GetChildNodes<Aspose.Note.Image>();

foreach (Aspose.Note.Image image in images)
{
    Console.WriteLine("Width: {0}", image.Width);
    Console.WriteLine("Height: {0}", image.Height);
    Console.WriteLine("OriginalWidth: {0}", image.OriginalWidth);
    Console.WriteLine("OriginalHeight: {0}", image.OriginalHeight);
    Console.WriteLine("FileName: {0}", image.FileName);
    Console.WriteLine("LastModifiedTime: {0}", image.LastModifiedTime);
    Console.WriteLine();
}

Insert an Image on a OneNote Document Page

Aspose.Diagram for .NET APIs now allows inserting an image anywhere on the OneNote document.

An image can be inserted in the following ways.

Insert an Image in an Existing OneNote Document

To insert an image on a OneNote document, follow these steps:

1. Use the Document.FirstChild property to get the first page.
2. Use the Image class constructor to load the image.
3. Use the Image.Width and Image.Height properties to adjust the size of the image.
4. Use the Image.VerticalOffset and Image.HorizontalOffset properties to set the location of the image.
5. Use the Page.AppendChild property to insert the image.
6. Save a OneNote document.

The code example given below demonstrates how to insert an image on a OneNote document and save them as files.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

// Load document from the stream.
Document doc = new Document(dataDir + "Aspose.one");
// Get the first page of the document.
Aspose.Note.Page page = doc.FirstChild;

// Load an image from the file.
Aspose.Note.Image image = new Aspose.Note.Image(doc, dataDir + "image.jpg");
// Change the image's size according to your needs (optional).
image.Width = 100;
image.Height = 100;
// Set the image's location in the page (optional).
image.VerticalOffset = 400;
image.HorizontalOffset = 100;
// Set image alignment
image.Alignment = HorizontalAlignment.Right;
// Add the image to the page.
page.AppendChildLast(image);            

Build a OneNote Document from Scratch and Insert an Image

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object and set offset properties
Outline outline = new Outline(doc) { VerticalOffset = 0, HorizontalOffset = 0 };
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
// Load an image by the file path.
Aspose.Note.Image image = new Aspose.Note.Image(doc, dataDir + "image.jpg");
// Set image alignment
image.Alignment = HorizontalAlignment.Right;
// Add image
outlineElem.AppendChildLast(image);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);

dataDir = dataDir + "BuildDocAndInsertImage_out.one";
// Save OneNote document
doc.Save(dataDir);

Build a OneNote Document from the Scratch and Insert an Image using an Image Stream

This code example shows how to build a new OneNote document and insert an image using the image stream.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);

Outline outline1 = new Outline(doc) { VerticalOffset = 600, HorizontalOffset = 0 };
OutlineElement outlineElem1 = new OutlineElement(doc);
FileStream fs = File.OpenRead(dataDir +  "image.jpg");
// Load the second image using the image name, extension and stream.
Aspose.Note.Image image1 = new Aspose.Note.Image(doc, "Penguins.jpg", fs);
// Set image alignment
image1.Alignment = HorizontalAlignment.Right;

outlineElem1.AppendChildLast(image1);
outline1.AppendChildLast(outlineElem1);
page.AppendChildLast(outline1);

doc.AppendChildLast(page);

dataDir = dataDir + "BuildDocAndInsertImageUsingImageStream_out.one";
// Save OneNote document
doc.Save(dataDir);

Support for Image Alternative Text

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images();

var document = new Document();
var page = new Page(document);
var image = new Image(document, dataDir + "image.jpg");
image.AlternativeTextTitle = "This is an image's title!";
image.AlternativeTextDescription = "And this is an image's description!";
page.AppendChildLast(image);
document.AppendChildLast(page);

dataDir = dataDir + "ImageAlternativeText_out.one";
document.Save(dataDir);

Link an Image to Hyperlink

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Images(); 
            
var document = new Document();

var page = new Page(document);

var image = new Image(document, dataDir + "image.jpg");
            
image.HyperlinkUrl = "http://image.com";
            
page.AppendChildLast(image);
            
document.AppendChildLast(page);
            
document.Save(dataDir + "Image with Hyperlink_out.one");

Remove an Image

var document = new Document("file.one");

var images = document.GetChildNodes<Image>();

foreach (Aspose.Note.Image image in images)
{
    if (image.ParentNode == null)
    {
        continue;
    }

    (image.ParentNode as Page)?.RemoveChild(image);
    // The parent element of the image can be not only the page
    (image.ParentNode as OutlineElement)?.RemoveChild(image);
}

document.Save("after.pdf");