API Reference
OneNoteNotebook
A OneNote notebook with ordered section groups and sections.
Inheritance
- Object
- OneNoteNotebook
Usage
Explore 10 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Method OneNoteNotebookReader.Read
- Method OneNotePackageReader.Read
Accepted by parameters 8
- Method OneNoteImageExportExtensions.ExportImages
- Method OneNoteImageExportExtensions.ToImages
- Extension method OneNoteNotebook.ExportImages
- Extension method OneNoteNotebook.ToImages
- Method OneNoteNotebookWriter.Write
- Method OneNotePackageWriter.Write
- Method OneNotePageTraversal.Flatten
- Method OneNoteTableOfContentsWriter.Write
Constructors
public OneNoteNotebook() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Guid? Id { get; set; } #Notebook identity when available. Serialization assigns and retains an identity for a new notebook.
public OneNoteStorageFormat TableOfContentsStorageFormat { get; internal set; } #Physical encoding of the loaded root .onetoc2, or unknown for a new notebook.
public UInt32? ColorArgb { get; set; } #Notebook color encoded as ARGB, when present.
public Boolean? HistoryEnabled { get; set; } #Whether the notebook enables version history.
public IList<OneNoteSectionGroup> SectionGroups { get; } #Top-level section groups in notebook order.
public IList<OneNoteSection> Sections { get; } #Top-level sections in notebook order.
public IList<OneNoteOpaqueObject> UnknownObjects { get; } #Opaque notebook objects preserved for loss-aware writing.
public IList<OneNoteDiagnostic> Diagnostics { get; } #Diagnostics produced while loading the notebook.
Extension Methods
public static IReadOnlyList<OfficeImageExportResult> ExportImages(OneNoteNotebook notebook, OfficeImageExportFormat format, OneNotePageBatchRenderingOptions? options = null) #IReadOnlyList<OfficeImageExportResult>Exports selected notebook pages using the shared five-format result contract.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.OneNote.OneNotePageBatchRenderingOptions? = null
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteNotebook notebook) #OneNotePageImageBatchExportBuilderStarts batch PNG/JPEG/TIFF/SVG/WebP export for all notebook pages.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteNotebook notebook, OneNotePageBatchRenderingOptions options) #OneNotePageImageBatchExportBuilderStarts batch export using a cloned options snapshot.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- options OfficeIMO.OneNote.OneNotePageBatchRenderingOptions