OneNote.Interfaces.ParagraphLoadOptions interface
A container for the visible content on a page. A Paragraph can contain any one ParagraphType type of content.
Remarks
Properties
$all | Specifying |
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. |
ink |
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 |
parent |
Gets the parent paragraph object. Throws if a parent paragraph does not exist. |
parent |
Gets the parent paragraph object. Returns null if a parent paragraph does not exist. |
parent |
Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. |
parent |
Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. |
rich |
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
image
Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
image?: OneNote.Interfaces.ImageLoadOptions;
Property Value
Remarks
inkWords
Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.
inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions;
Property Value
Remarks
outline
Gets the Outline object that contains the Paragraph.
outline?: OneNote.Interfaces.OutlineLoadOptions;
Property Value
Remarks
paragraphs
The collection of paragraphs under this paragraph. Read only
paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
Property Value
Remarks
parentParagraph
Gets the parent paragraph object. Throws if a parent paragraph does not exist.
parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;
Property Value
Remarks
parentParagraphOrNull
Gets the parent paragraph object. Returns null if a parent paragraph does not exist.
parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;
Property Value
Remarks
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
Remarks
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
Remarks
richText
Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
richText?: OneNote.Interfaces.RichTextLoadOptions;
Property Value
Remarks
table
Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.
table?: OneNote.Interfaces.TableLoadOptions;
Property Value
Remarks
type
Gets the type of the Paragraph object. Read-only.
type?: boolean;
Property Value
boolean
Remarks
Office Add-ins