API Reference

Class

OneNoteSection

Namespace OfficeIMO.OneNote
Assembly OfficeIMO.OneNote
Modifiers sealed

A OneNote section and its ordered pages.

Inheritance

  • Object
  • OneNoteSection

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Methods

public Void Save(String path, OneNoteWriterOptions options = null) #
Returns: Void

Writes this section to an offline .one file.

Parameters

path System.String requiredposition: 0
options OfficeIMO.OneNote.OneNoteWriterOptions = null optionalposition: 1
public Byte[] ToByteArray(OneNoteWriterOptions options = null) #
Returns: Byte[]

Serializes this section as an offline .one payload.

Parameters

options OfficeIMO.OneNote.OneNoteWriterOptions = null optionalposition: 0

Properties

public Nullable<UInt32> TableOfContentsOrder { get; set; } #

Relative navigation order among sibling sections and section groups when loaded from or written to a notebook TOC. Items without an explicit order follow ordered items in their collection order.

public Nullable<Guid> Id { get; set; } #

Section identity when available. Serialization assigns and retains an identity for a new section.

public String Name { get; set; } #

Section display name.

public String SourcePath { get; set; } #

Source .one path or package entry.

public OneNoteStorageFormat StorageFormat { get; set; } #

Physical encoding of the loaded section, or unknown for a newly created section.

public Nullable<UInt32> ColorArgb { get; set; } #

Section color encoded as ARGB, when present.

public IList<OneNotePage> Pages { get; } #

Ordered top-level pages and subpages.

public IList<OneNoteRevision> Revisions { get; } #

Revision metadata associated with the section object space.

public IList<OneNoteOpaqueObject> UnknownObjects { get; } #

Opaque section objects preserved for loss-aware writing.

public IList<OneNoteDiagnostic> Diagnostics { get; } #

Diagnostics produced while loading the section.

Extension Methods

public static IReadOnlyList<OfficeImageExportResult> ExportImages(OneNoteSection section, OfficeImageExportFormat format, OneNotePageBatchRenderingOptions options = null) #
Returns: IReadOnlyList<OfficeImageExportResult>

Exports selected section pages using the shared five-format result contract.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.OneNote.OneNotePageBatchRenderingOptions = null optionalposition: 2
ToImages 2 overloads
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteSection section) #
Returns: OneNotePageImageBatchExportBuilder

Starts batch PNG/JPEG/TIFF/SVG/WebP export for all section pages.

Parameters

section OfficeIMO.OneNote.OneNoteSection requiredposition: 0
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteSection section, OneNotePageBatchRenderingOptions options) #
Returns: OneNotePageImageBatchExportBuilder

Starts batch export using a cloned options snapshot.

Parameters

section OfficeIMO.OneNote.OneNoteSection requiredposition: 0
options OfficeIMO.OneNote.OneNotePageBatchRenderingOptions requiredposition: 1