OneNote.Interfaces.ParagraphLoadOptions interface

Package:

onenote

A container for the visible content on a page. A Paragraph can contain any one ParagraphType type of content.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
id	Gets the ID of the Paragraph object. Read-only.
image	Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
inkWords	Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.
outline	Gets the Outline object that contains the Paragraph.
paragraphs	The collection of paragraphs under this paragraph. Read only
parentParagraph	Gets the parent paragraph object. Throws if a parent paragraph does not exist.
parentParagraphOrNull	Gets the parent paragraph object. Returns null if a parent paragraph does not exist.
parentTableCell	Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound.
parentTableCellOrNull	Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null.
richText	Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
table	Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.
type	Gets the type of the Paragraph object. Read-only.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

image

Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.

image?: OneNote.Interfaces.ImageLoadOptions;

Property Value

OneNote.Interfaces.ImageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

inkWords

Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.

inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions;

Property Value

OneNote.Interfaces.InkWordCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

outline

Gets the Outline object that contains the Paragraph.

outline?: OneNote.Interfaces.OutlineLoadOptions;

Property Value

OneNote.Interfaces.OutlineLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

paragraphs

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

Gets the parent paragraph object. Throws if a parent paragraph does not exist.

parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentParagraphOrNull

Gets the parent paragraph object. Returns null if a parent paragraph does not exist.

parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentTableCell

Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound.

parentTableCell?: OneNote.Interfaces.TableCellLoadOptions;

Property Value

OneNote.Interfaces.TableCellLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentTableCellOrNull

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

Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.

richText?: OneNote.Interfaces.RichTextLoadOptions;

Property Value

OneNote.Interfaces.RichTextLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

table

Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.

table?: OneNote.Interfaces.TableLoadOptions;

Property Value

OneNote.Interfaces.TableLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

type

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

type?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]