Edit

Share via

OneNote.Interfaces.PageContentData interface

  • Reference
Package:
onenote

An interface describing the data returned by calling pageContent.toJSON().

Properties

id

Gets the ID of the PageContent object. Read-only.
image

Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
ink

Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
left

Gets or sets the left (X-axis) position of the PageContent object.
outline

Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.
top

Gets or sets the top (Y-axis) position of the PageContent object.
type

Gets the type of the PageContent object. Read-only.

Property Details

id

Gets the ID of the PageContent object. Read-only.

id?: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

image

Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.

image?: OneNote.Interfaces.ImageData;

Property Value

OneNote.Interfaces.ImageData

Remarks

[ API set: OneNoteApi 1.1 ]

ink

Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.

ink?: OneNote.Interfaces.FloatingInkData;

Property Value

OneNote.Interfaces.FloatingInkData

Remarks

[ API set: OneNoteApi 1.1 ]

left

Gets or sets the left (X-axis) position of the PageContent object.

left?: number;

Property Value

number

Remarks

[ API set: OneNoteApi 1.1 ]

outline

Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.

outline?: OneNote.Interfaces.OutlineData;

Property Value

OneNote.Interfaces.OutlineData

Remarks

[ API set: OneNoteApi 1.1 ]

top

Gets or sets the top (Y-axis) position of the PageContent object.

top?: number;

Property Value

number

Remarks

[ API set: OneNoteApi 1.1 ]

type

Gets the type of the PageContent object. Read-only.

type?: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

Property Value

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

Remarks

[ API set: OneNoteApi 1.1 ]