OneNote.Interfaces.ParagraphCollectionLoadOptions interface

Package:

onenote

Represents a collection of Paragraph objects.

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	For EACH ITEM in the collection: Gets the ID of the Paragraph object. Read-only.
image	For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
inkWords	For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
outline	For EACH ITEM in the collection: Gets the Outline object that contains the Paragraph.
paragraphs	For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.
parentParagraph	For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
parentParagraphOrNull	For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
parentTableCell	For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
parentTableCellOrNull	For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null.
richText	For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText.
table	For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
type	For EACH ITEM in the collection: Gets the type of the Paragraph 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 Paragraph object. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

image

For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.

image?: OneNote.Interfaces.ImageLoadOptions;

Property Value

OneNote.Interfaces.ImageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

inkWords

For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.

inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions;

Property Value

OneNote.Interfaces.InkWordCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

outline

For EACH ITEM in the collection: Gets the Outline object that contains the Paragraph.

outline?: OneNote.Interfaces.OutlineLoadOptions;

Property Value

OneNote.Interfaces.OutlineLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

paragraphs

For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.

paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;

Property Value

OneNote.Interfaces.ParagraphCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentParagraph

For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.

parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentParagraphOrNull

For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.

parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentTableCell

For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.

parentTableCell?: OneNote.Interfaces.TableCellLoadOptions;

Property Value

OneNote.Interfaces.TableCellLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentTableCellOrNull

For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null.

parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions;

Property Value

OneNote.Interfaces.TableCellLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

richText

For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText.

richText?: OneNote.Interfaces.RichTextLoadOptions;

Property Value

OneNote.Interfaces.RichTextLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

table

For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.

table?: OneNote.Interfaces.TableLoadOptions;

Property Value

OneNote.Interfaces.TableLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

type

For EACH ITEM in the collection: Gets the type of the Paragraph object. Read-only.

type?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]