Edit

Share via

OneNote.Interfaces.InkWordCollectionLoadOptions interface

Package:
onenote

Represents a collection of InkWord objects.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$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).
id

For EACH ITEM in the collection: Gets the ID of the InkWord object. Read-only.
languageId

For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only.
paragraph

For EACH ITEM in the collection: The parent paragraph containing the ink word.
wordAlternates

For EACH ITEM in the collection: The words that were recognized in this ink word, in order of likelihood. 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 InkWord object. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

languageId

For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only.

languageId?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

paragraph

For EACH ITEM in the collection: The parent paragraph containing the ink word.

paragraph?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

wordAlternates

For EACH ITEM in the collection: The words that were recognized in this ink word, in order of likelihood. Read-only.

wordAlternates?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]