Edit

Share via

OneNote.Interfaces.RichTextLoadOptions interface

  • Reference
Package:
onenote

Represents a RichText object in a Paragraph.

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 RichText object. Read-only.
languageId

The language id of the text. Read-only.
paragraph

Gets the Paragraph object that contains the RichText object.
style

Gets the text style of the RichText object. Read-only.
text

Gets the text content of the RichText 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 RichText object. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

languageId

The language id of the text. Read-only.

languageId?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

paragraph

Gets the Paragraph object that contains the RichText object.

paragraph?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

style

Gets the text style of the RichText object. Read-only.

style?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.8 ]

text

Gets the text content of the RichText object. Read-only.

text?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]