OneNote.Interfaces.PageContentCollectionLoadOptions interface
Represents the contents of a page, as a collection of PageContent objects.
Remarks
Properties
| $all | Specifying |
| id | For EACH ITEM in the collection: Gets the ID of the PageContent object. Read-only. |
| image | For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. |
| ink | For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. |
| left | For EACH ITEM in the collection: Gets or sets the left (X-axis) position of the PageContent object. |
| outline | For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. |
| parent |
For EACH ITEM in the collection: Gets the page that contains the PageContent object. |
| top | For EACH ITEM in the collection: Gets or sets the top (Y-axis) position of the PageContent object. |
| type | For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Gets the ID of the PageContent object. Read-only.
id?: boolean;
Property Value
boolean
Remarks
image
For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
image?: OneNote.Interfaces.ImageLoadOptions;
Property Value
Remarks
ink
For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
ink?: OneNote.Interfaces.FloatingInkLoadOptions;
Property Value
Remarks
left
For EACH ITEM in the collection: Gets or sets the left (X-axis) position of the PageContent object.
left?: boolean;
Property Value
boolean
Remarks
outline
For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.
outline?: OneNote.Interfaces.OutlineLoadOptions;
Property Value
Remarks
parentPage
For EACH ITEM in the collection: Gets the page that contains the PageContent object.
parentPage?: OneNote.Interfaces.PageLoadOptions;
Property Value
Remarks
top
For EACH ITEM in the collection: Gets or sets the top (Y-axis) position of the PageContent object.
top?: boolean;
Property Value
boolean
Remarks
type
For EACH ITEM in the collection: Gets the type of the PageContent object. Read-only.
type?: boolean;
Property Value
boolean