Edit

Share via

OneNote.Interfaces.PageContentLoadOptions interface

  • Reference
Package:
onenote

Represents a region on a page that contains top-level content types such as Outline or Image. A PageContent object can be assigned an XY position.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
id

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

Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
ink

Gets the ink in the PageContent object. Throws an exception if PageContentType is not 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 is not Outline.
parentPage

Gets the page that contains the PageContent object.
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

image

Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.

image?: OneNote.Interfaces.ImageLoadOptions;

Property Value

OneNote.Interfaces.ImageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

ink

Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink.

ink?: OneNote.Interfaces.FloatingInkLoadOptions;

Property Value

OneNote.Interfaces.FloatingInkLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

left

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

left?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

outline

Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline.

outline?: OneNote.Interfaces.OutlineLoadOptions;

Property Value

OneNote.Interfaces.OutlineLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentPage

Gets the page that contains the PageContent object.

parentPage?: OneNote.Interfaces.PageLoadOptions;

Property Value

OneNote.Interfaces.PageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

top

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

top?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

type

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

type?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]