Class NotebookImageSaveOptions

NotebookImageSaveOptions class

Allows to specify additional options when rendering notebook pages to images.

public class NotebookImageSaveOptions : NotebookSaveOptions<ImageSaveOptions>

Constructors

NameDescription
NotebookImageSaveOptions(SaveFormat)Initializes a new instance of the NotebookImageSaveOptions class.

Properties

NameDescription
DeferredSaving { get; set; }Gets or sets a value indicating whether children documents should be saved explicitly.
DocumentSaveOptions { get; }
Flatten { get; set; }Gets or sets a value indicating whether the notebook children hierarchy is saved flattened.
override SaveFormat { get; }

Methods

NameDescription
override GetDocumentSaveOptions()

Examples

Shows how to save flattened notebook in pdf format.

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

// Load a OneNote Notebook
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Save the Notebook
dataDir = dataDir + "ConvertToPDFAsFlattened_out.pdf";
notebook.Save(
    dataDir,
    new NotebookPdfSaveOptions
    {
        Flatten = true
    });

Shows how to save notebook as image with specified options.

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

// Load a OneNote Notebook
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

var notebookSaveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

var documentSaveOptions = notebookSaveOptions.DocumentSaveOptions;

documentSaveOptions.Resolution = 400;

dataDir = dataDir + "ConvertToImageWithOptions_out.png";

// Save the Notebook
notebook.Save(dataDir, notebookSaveOptions);

Shows how to save flattened notebook as image.

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

// Load a OneNote Notebook
var notebook = new Notebook(dataDir + "Notizbuch öffnen.onetoc2");

var notebookSaveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

var documentSaveOptions = notebookSaveOptions.DocumentSaveOptions;

documentSaveOptions.Resolution = 400;
notebookSaveOptions.Flatten = true;

dataDir = dataDir + "ConvertToImageAsFlattenedNotebook_out.png";

// Save the Notebook
notebook.Save(dataDir, notebookSaveOptions);

See Also