OneNote.Interfaces.ParagraphData interface

Package:

onenote

An interface describing the data returned by calling paragraph.toJSON().

Properties

id	Gets the ID of the Paragraph object. Read-only.
image	Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only.
inkWords	Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only.
paragraphs	The collection of paragraphs under this paragraph. Read only
richText	Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. Read-only
table	Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only.
type	Gets the type of the Paragraph object. Read-only.

Property Details

id

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

id?: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

image

Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only.

image?: OneNote.Interfaces.ImageData;

Property Value

OneNote.Interfaces.ImageData

Remarks

[ API set: OneNoteApi 1.1 ]

inkWords

Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only.

inkWords?: OneNote.Interfaces.InkWordData[];

Property Value

OneNote.Interfaces.InkWordData[]

Remarks

[ API set: OneNoteApi 1.1 ]

paragraphs

The collection of paragraphs under this paragraph. Read only

paragraphs?: OneNote.Interfaces.ParagraphData[];

Property Value

OneNote.Interfaces.ParagraphData[]

Remarks

[ API set: OneNoteApi 1.1 ]

richText

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

richText?: OneNote.Interfaces.RichTextData;

Property Value

OneNote.Interfaces.RichTextData

Remarks

[ API set: OneNoteApi 1.1 ]

table

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

table?: OneNote.Interfaces.TableData;

Property Value

OneNote.Interfaces.TableData

Remarks

[ API set: OneNoteApi 1.1 ]

type

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

type?: OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other";

Property Value

OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other"

Remarks

[ API set: OneNoteApi 1.1 ]