OneNote.Interfaces.ParagraphCollectionLoadOptions interface
Represents a collection of Paragraph objects.
Remarks
Properties
| $all | Specifying |
| 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. |
| ink |
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. |
| parent |
For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. |
| parent |
For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. |
| parent |
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. |
| parent |
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. |
| rich |
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
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
Remarks
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
Remarks
outline
For EACH ITEM in the collection: Gets the Outline object that contains the Paragraph.
outline?: OneNote.Interfaces.OutlineLoadOptions;Property Value
Remarks
paragraphs
For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.
paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;Property Value
Remarks
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
Remarks
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
Remarks
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
Remarks
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
Remarks
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
Remarks
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
Remarks
type
For EACH ITEM in the collection: Gets the type of the Paragraph object. Read-only.
type?: boolean;Property Value
boolean