Create and Load a OneNote Document

Aspose.Note API supports loading Microsoft.Note documents using its Document Object Model. It supports loading Microsoft OneNote 2010, 2013 and OneNote Online (SharePoint) file formats. It provides support for .one as well as .onetoc2 file formats.

Create a OneNote and Save into HTML Format

Aspose.Note supports creating a OneNote file and then saving it into HTML file format. To use this feature, import the Aspose.Note.Saving namespace into your application project. It has numerous valuable classes for rendering, for example, HtmlSaveOptions, ImageSaveOptions, PdfSaveOptions, and SaveOptions.

Aspose.Note for .NET offers the Document class that represents a OneNote file. The Document class exposes the Save method that can be called to convert the OneNote file into the HTML file format. The HtmlSaveOptions class provides options for creating HTML file, such as PageIndex, PageCount, SaveFormat and others.

Creating a OneNote Document and Saving into HTML using the Default Options

The following code example demonstrates how to create a OneNote and save into the HTML using the default options.

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

// Initialize OneNote document
Document doc = new Document();
Aspose.Note.Page page = new Aspose.Note.Page(doc);

// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title(doc)
{
    TitleText = new RichText(doc) { Text = "Title text.", ParagraphStyle = textStyle },
    TitleDate = new RichText(doc) { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
    TitleTime = new RichText(doc) { Text = "12:34", ParagraphStyle = textStyle }
};
doc.AppendChildLast(page);
dataDir = dataDir + "CreateOneNoteDocAndSaveToHTML_out.html";
// Save as HTML format
doc.Save(dataDir);

Creating a OneNote Document and Saving a Page Range into HTML

The following code example demonstrates how to create a OneNote and save a page range into HTML using the HtmlSaveOptions class. It sets the PageCount and PageIndex properties.

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

// Initialize OneNote document
Document doc = new Document();

Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title(doc)
{
    TitleText = new RichText(doc) { Text = "Title text.", ParagraphStyle = textStyle },
    TitleDate = new RichText(doc) { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
    TitleTime = new RichText(doc) { Text = "12:34", ParagraphStyle = textStyle }
};
doc.AppendChildLast(page);

dataDir = dataDir + "CreateAndSavePageRange_out.html";
// Save as HTML format
doc.Save(dataDir, new HtmlSaveOptions
{
    PageCount = 1,
    PageIndex = 0
});

Save to Memory Stream with Embedded Resources

string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");

var options = new HtmlSaveOptions()
{
    ExportCss = ResourceExportType.ExportEmbedded,
    ExportFonts = ResourceExportType.ExportEmbedded,
    ExportImages = ResourceExportType.ExportEmbedded,
    FontFaceTypes = FontFaceType.Ttf
};
var r = new MemoryStream();
document.Save(r, options);

Save to Memory Stream with Callbacks

// This code creates documentFolder containing document.html, css folder with style.css file, images folder with images and fonts folder with fonts.
// style.css file will contains at the end the following string "/* This line is appended to stream manually by user */"
var options = new HtmlSaveOptions()
{
    FontFaceTypes = FontFaceType.Ttf
};
var savingCallbacks = new UserSavingCallbacks()
{
    RootFolder = "documentFolder",
    CssFolder = "css",
    KeepCssStreamOpened = true,
    ImagesFolder = "images",
    FontsFolder = "fonts"
};
options.CssSavingCallback = savingCallbacks;
options.FontSavingCallback = savingCallbacks;
options.ImageSavingCallback = savingCallbacks;

if (!Directory.Exists(savingCallbacks.RootFolder))
{
    Directory.CreateDirectory(savingCallbacks.RootFolder);
}

string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");

using (var stream = File.Create(Path.Combine(savingCallbacks.RootFolder, "document.html")))
{
    document.Save(stream, options);
}

using (var writer = new StreamWriter(savingCallbacks.CssStream))
{
    writer.WriteLine();
    writer.WriteLine("/* This line is appended to stream manually by user */");
}

The above sample will require the following class for execution.

// For complete examples and data files, please go to https://github.com/aspose-note/Aspose.Note-for-.NET
class UserSavingCallbacks : ICssSavingCallback, IFontSavingCallback, IImageSavingCallback
{
    public string RootFolder { get; set; }
    public bool KeepCssStreamOpened { get; set; }
    public string CssFolder { get; set; }
    public Stream CssStream { get; private set; }
    public string FontsFolder { get; set; }
    public string ImagesFolder { get; set; }
    public void FontSaving(FontSavingArgs args)
    {
        string uri;
        Stream stream;
        this.CreateResourceInFolder(this.FontsFolder, args.FileName, out uri, out stream);
        args.Stream = stream;
        args.Uri = Path.Combine("..", uri).Replace("\\", "\\\\");
    }
    public void CssSaving(CssSavingArgs args)
    {
        string uri;
        Stream stream;
        this.CreateResourceInFolder(this.CssFolder, args.FileName, out uri, out stream);
        args.Stream = this.CssStream = stream;
        args.KeepStreamOpen = this.KeepCssStreamOpened;
        args.Uri = uri;
    }
    public void ImageSaving(ImageSavingArgs args)
    {
        string uri;
        Stream stream;
        this.CreateResourceInFolder(this.ImagesFolder, args.FileName, out uri, out stream);
        args.Stream = stream;
        args.Uri = uri;
    }
    private void CreateResourceInFolder(string folder, string filename, out string uri, out Stream stream)
    {
        var relativePath = folder;
        var fullPath = Path.Combine(this.RootFolder, relativePath);
        if (!Directory.Exists(fullPath))
        {
            Directory.CreateDirectory(fullPath);
        }
        stream = File.Create(Path.Combine(fullPath, filename));
        uri = Path.Combine(relativePath, filename);
    }
}

Save as HTML File with Resources In Separate File

string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");

var options = new HtmlSaveOptions()
{
    ExportCss = ResourceExportType.ExportEmbedded,
    ExportFonts = ResourceExportType.ExportEmbedded,
    ExportImages = ResourceExportType.ExportEmbedded,
    FontFaceTypes = FontFaceType.Ttf
};
document.Save(dataDir + "document_out.html", options);

Loading OneNote Documents

The Document class exposed by the API can be used to load Microsoft OneNote .one file format files. The following code example demonstrates the usage of this class for loading a Microsoft OneNote document.

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

Increase Performance for Consequent Export Operations

Aspose.Note for .NET APIs allow to increase 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 .NET offers the Document class that represents a OneNote file. The Document class exposes the AutomaticLayoutChangesDetectionEnabled property and DetectLayoutChanges method, their combine use enable users to disable automatic detection of layout changes and handle them manually:

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

// Initialize the new Document
Document doc = new Document() { AutomaticLayoutChangesDetectionEnabled = false };
// Initialize the new Page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title(doc)
{
    TitleText = new RichText(doc) { Text = "Title text.", ParagraphStyle = textStyle },
    TitleDate = new RichText(doc) { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
    TitleTime = new RichText(doc) { Text = "12:34", ParagraphStyle = textStyle }
};
// Append page node
doc.AppendChildLast(page);
// Save OneNote document in different formats, set text font size and detect layout changes manually.
doc.Save(dataDir + "ConsequentExportOperations_out.html");            
doc.Save(dataDir + "ConsequentExportOperations_out.pdf");            
doc.Save(dataDir + "ConsequentExportOperations_out.jpg");            
textStyle.FontSize = 11;           
doc.DetectLayoutChanges();            
doc.Save(dataDir + "ConsequentExportOperations_out.bmp");

Working with Password Protected OneNote Documents

Creating Password Protected OneNote Documents

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

Document document = new Document();
document.Save(dataDir + "CreatingPasswordProtectedDoc_out.one", new OneSaveOptions() { DocumentPassword = "pass" });

Loading Password Protected OneNote Documents

Aspose.Note API allows to load a password-protected OneNote documents. The API’s LoadOptions class provides the DocumentPassword property to specify the document password. 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 DocumentPassword property
3. Load the document with the defined object of the LoadOptions class

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

LoadOptions loadOptions = new LoadOptions
{
    DocumentPassword = "password"
};
Document doc = new Document(dataDir + "Sample1.one", loadOptions);
            

            string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
            string fileName = Path.Combine(dataDir, "Aspose.one");

            Document document;
            if (!Document.IsEncrypted(fileName, out document))
            {
                Console.WriteLine("The document is loaded and ready to be processed.");
            }
            else
            {
                Console.WriteLine("The document is encrypted. Provide a password.");
            }

            string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
            string fileName = Path.Combine(dataDir, "Aspose.one");

            Document document;
            if (Document.IsEncrypted(fileName, "VerySecretPassword", out document))
            {
                if (document != null)
                {
                    Console.WriteLine("The document is decrypted. It is loaded and ready to be processed.");
                }
                else
                {
                    Console.WriteLine("The document is encrypted. Invalid password was provided.");
                }
            }
            else
            {
                Console.WriteLine("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 the 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 clones 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 KeepSOlidObjectsAlgoirthm

// For complete examples and data files, please go to https://github.com/kashifiqb/Aspose.Note-for-.NET
var pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.PageSplittingAlgorithm = new AlwaysSplitObjectsAlgorithm();
// Or
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm();
// Or
pdfSaveOptions.PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm();

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/kashifiqb/Aspose.Note-for-.NET
float heightLimitOfClonedPart = 500;
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm(heightLimitOfClonedPart);
// Or
pdfSaveOptions.PageSplittingAlgorithm = 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/kashifiqb/Aspose.Note-for-.NET
pdfSaveOptions.PageSplittingAlgorithm = 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/kashifiqb/Aspose.Note-for-.NET
pdfSaveOptions.PageSplittingAlgorithm = 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/kashifiqb/Aspose.Note-for-.NET
pdfSaveOptions.PageSplittingAlgorithm = 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/kashifiqb/Aspose.Note-for-.NET
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm(400);

AlwaysSplitObjectsAlgorithm

Images were split into the pages joint.