Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

Read and Write OneNote Notebooks

Edit on GitHub

Open OneNote notebooks from a folder, a .onetoc2 file or a .onepkg export, walk section groups and sections, and write notebooks offline.

Packages
Works with
Target frameworks
netstandard2.0, net8.0, net10.0, net472
Limits
.onepkg reading supports single Cabinet archives with uncompressed, MSZIP or LZX folders; Quantum compression and multi-file cabinet sets are not supported. OfficeIMO.OneNote support matrix
Verified
Examples compiled against the source on

A OneNote notebook is a folder with an Open Notebook.onetoc2 table of contents, .one section files and subfolders for section groups. A .onepkg file is the same notebook packed into a Cabinet archive. OneNoteNotebookReader opens the folder form and OneNotePackageReader opens the package; both return a OneNoteNotebook with section groups, sections and pages. OneNoteNotebookWriter and OneNotePackageWriter write them back.

Open a notebook folder or table of contents

C#

using OfficeIMO.OneNote;

OneNoteNotebook notebook = OneNoteNotebookReader.Read(
    Path.Combine("Work notebook", "Open Notebook.onetoc2"),
    new OneNoteNotebookReaderOptions {
        IncludeRecycleBin = false,
        ContinueOnSectionError = true
    });

Console.WriteLine(notebook.Name);
foreach (OneNoteDiagnostic diagnostic in notebook.Diagnostics) {
    Console.WriteLine(diagnostic);
}

PowerShell

$notebook = Open-OfficeOneNote -Path '.\Work notebook\Open Notebook.onetoc2'
$notebook.Sections | Select-Object Name

Walk section groups, sections and pages

C#

using OfficeIMO.OneNote;

OneNoteNotebook notebook = OneNotePackageReader.Read("Work notebook.onepkg");

void PrintGroup(string name, IList<OneNoteSection> sections, IList<OneNoteSectionGroup> groups, int depth) {
    string indent = new string(' ', depth * 2);
    Console.WriteLine($"{indent}[{name}]");
    foreach (OneNoteSection section in sections) {
        Console.WriteLine($"{indent}  {section.Name} ({section.Pages.Count} pages)");
        foreach (OneNotePage page in section.Pages) {
            Console.WriteLine($"{indent}    - {page.Title}");
        }
    }
    foreach (OneNoteSectionGroup group in groups) {
        PrintGroup(group.Name, group.Sections, group.SectionGroups, depth + 1);
    }
}

PrintGroup(notebook.Name, notebook.Sections, notebook.SectionGroups, 0);

PowerShell

$options = New-OfficeOneNoteNotebookOptions -IncludeRecycleBin
$notebook = Open-OfficeOneNote -Path '.\Work notebook.onepkg' -Options $options
$notebook.Sections | ForEach-Object { $_.Pages } | Select-Object Title, LastModifiedUtc

List the notebook structure without loading pages

Set LoadSectionContent = false to read only the table of contents, which is fast for large notebooks.

C#

using OfficeIMO.OneNote;

OneNoteNotebook notebook = OneNoteNotebookReader.Read(
    Path.Combine("Work notebook", "Open Notebook.onetoc2"),
    new OneNoteNotebookReaderOptions { LoadSectionContent = false });

foreach (OneNoteSection section in notebook.Sections) {
    Console.WriteLine(section.Name);
}
foreach (OneNoteSectionGroup group in notebook.SectionGroups) {
    Console.WriteLine($"{group.Name}/ ({group.Sections.Count} sections)");
}

PowerShell

$options = New-OfficeOneNoteNotebookOptions -NoSectionContent
Open-OfficeOneNote -Path '.\Work notebook\Open Notebook.onetoc2' -Options $options

Create a notebook and a .onepkg package

C#

using OfficeIMO.OneNote;

var notebook = new OneNoteNotebook { Name = "Offline notebook" };

var section = OneNoteSection.Create();
section.Name = "Meetings";
var page = new OneNotePage { Title = "Kickoff" };
var paragraph = new OneNoteParagraph();
paragraph.Runs.Add(new OneNoteTextRun { Text = "Agreed scope and timeline." });
page.DirectContent.Add(paragraph);
section.Pages.Add(page);
notebook.Sections.Add(section);

OneNoteNotebookWriter.Write(notebook, "Offline notebook");
OneNotePackageWriter.Write(notebook, "Offline notebook.onepkg");

OneNoteNotebook reopened = OneNotePackageReader.Read("Offline notebook.onepkg");
Console.WriteLine($"{reopened.Name}: {reopened.Sections.Count} section(s)");

Example source