API Reference

Class

OneNotePage

Namespace OfficeIMO.OneNote
Assembly OfficeIMO.OneNote
Modifiers sealed

A OneNote page, including subpage level, content, revisions, and conflict metadata.

Inheritance

  • Object
  • OneNotePage

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

Properties

public OneNoteExtendedGuid Id { get; set; } #

Page object-space identity when available. Serialization assigns and retains an identity for a new page.

public OneNoteExtendedGuid RevisionContextId { get; set; } #

Revision context identity for a historical page snapshot. Serialization assigns it when needed.

public String Title { get; set; } #

Page title.

public Int32 Level { get; set; } #

Zero-based subpage nesting level.

public Nullable<DateTime> CreatedUtc { get; set; } #

Page creation time.

public Nullable<DateTime> LastModifiedUtc { get; set; } #

Most recent page modification time.

public String OriginalAuthor { get; set; } #

Original author.

public String MostRecentAuthor { get; set; } #

Most recent author.

public Boolean IsConflictPage { get; set; } #

Whether this is a conflict page.

public Boolean IsVersionHistoryPage { get; set; } #

Whether this is a version-history page.

public Boolean IsDeleted { get; set; } #

Whether the page is marked as deleted content.

public Nullable<Double> Width { get; set; } #

Optional width in OneNote half-inch layout units.

public Nullable<Double> Height { get; set; } #

Optional height in OneNote half-inch layout units.

public Nullable<OneNotePageSize> PageSize { get; set; } #

Named native page size, or automatic sizing when absent.

public Nullable<OneNotePageOrientation> Orientation { get; set; } #

Native page orientation.

public OneNotePageMargins Margins { get; } #

Page margins and their layout origins, in half-inch units.

public Nullable<Boolean> RightToLeft { get; set; } #

Whether the page uses right-to-left root layout.

public Nullable<Boolean> IsReadOnly { get; set; } #

Whether the page is marked read-only.

public Nullable<Boolean> ResolveChildCollisions { get; set; } #

Whether OneNote resolves collisions between freely positioned outlines.

public IList<OneNoteOutline> Outlines { get; } #

Page-level outlines in source order.

public IList<OneNoteElement> DirectContent { get; } #

Content placed directly on the page outside outlines.

public IList<OneNotePage> ConflictPages { get; } #

Conflict pages associated with this page.

public IList<OneNotePage> VersionHistory { get; } #

Version-history snapshots associated with this page.

public IList<OneNoteRevision> Revisions { get; } #

Revision metadata associated with the page object space.

public IList<OneNoteOpaqueObject> UnknownObjects { get; } #

Opaque page objects preserved for loss-aware writing.

public IList<OneNoteDiagnostic> Diagnostics { get; } #

Diagnostics produced while loading the page.

Extension Methods

public static OfficeImageExportResult ExportImage(OneNotePage page, OfficeImageExportFormat format, OneNotePageRenderingOptions options = null, CancellationToken cancellationToken = null) #
Returns: OfficeImageExportResult

Exports a page using the shared five-format result contract.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.OneNote.OneNotePageRenderingOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static OfficeDrawing ToDrawing(OneNotePage page, OneNotePageRenderingOptions options = null) #
Returns: OfficeDrawing

Creates the reusable Drawing scene for a page.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
options OfficeIMO.OneNote.OneNotePageRenderingOptions = null optionalposition: 1
ToImage 2 overloads
public static OneNotePageImageExportBuilder ToImage(OneNotePage page) #
Returns: OneNotePageImageExportBuilder

Starts fluent PNG/JPEG/TIFF/SVG/WebP export for a page.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
public static OneNotePageImageExportBuilder ToImage(OneNotePage page, OneNotePageRenderingOptions options) #
Returns: OneNotePageImageExportBuilder

Starts fluent export using a cloned options snapshot.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
options OfficeIMO.OneNote.OneNotePageRenderingOptions requiredposition: 1