Edit

Share via

OneNote.InkWord class

  • Reference
Package:
onenote

A container for the ink in a word in a paragraph.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
id

Gets the ID of the InkWord object.
languageId

The ID of the recognized language in this ink word.
paragraph

The parent paragraph containing the ink word.
wordAlternates

The words that were recognized in this ink word, in order of likelihood.

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original OneNote.InkWord object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkWordData) that contains shallow copies of any loaded child properties from the original object.
track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

OneNote.RequestContext

id

Gets the ID of the InkWord object.

readonly id: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

languageId

The ID of the recognized language in this ink word.

readonly languageId: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

paragraph

The parent paragraph containing the ink word.

readonly paragraph: OneNote.Paragraph;

Property Value

OneNote.Paragraph

Remarks

[ API set: OneNoteApi 1.1 ]

wordAlternates

The words that were recognized in this ink word, in order of likelihood.

readonly wordAlternates: string[];

Property Value

string[]

Remarks

[ API set: OneNoteApi 1.1 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: OneNote.Interfaces.InkWordLoadOptions): OneNote.InkWord;

Parameters

options
OneNote.Interfaces.InkWordLoadOptions

Provides options for which properties of the object to load.

Returns

OneNote.InkWord

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): OneNote.InkWord;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

OneNote.InkWord

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.InkWord;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

OneNote.InkWord

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original OneNote.InkWord object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkWordData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): OneNote.Interfaces.InkWordData;

Returns

OneNote.Interfaces.InkWordData

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.

track(): OneNote.InkWord;

Returns

OneNote.InkWord

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): OneNote.InkWord;

Returns

OneNote.InkWord