Edit

Share via

OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions interface

  • Reference
Package:
onenote

Represents a collection of InkAnalysisWord 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 InkAnalysisWord object. Read-only.
languageId

For EACH ITEM in the collection: The id of the recognized language in this inkAnalysisWord. Read-only.
line

For EACH ITEM in the collection: Reference to the parent InkAnalysisLine.
strokePointers

For EACH ITEM in the collection: Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only.
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 InkAnalysisWord 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 inkAnalysisWord. Read-only.

languageId?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

line

For EACH ITEM in the collection: Reference to the parent InkAnalysisLine.

line?: OneNote.Interfaces.InkAnalysisLineLoadOptions;

Property Value

OneNote.Interfaces.InkAnalysisLineLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

strokePointers

For EACH ITEM in the collection: Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only.

strokePointers?: boolean;

Property Value

boolean

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 ]