OneNote.InkWordCollection class

Package:

onenote

Represents a collection of InkWord objects.

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.
count	Returns the number of InkWords in the page.
items	Gets the loaded child items in this collection.

Methods

getItem(index)	Gets a InkWord object by ID or by its index in the collection. Read-only.
getItemAt(index)	Gets a InkWord on its position in the collection.
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.InkWordCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkWordCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
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

count

Returns the number of InkWords in the page.

readonly count: number;

Property Value

number

Remarks

[ API set: OneNoteApi 1.1 ]

items

Gets the loaded child items in this collection.

readonly items: OneNote.InkWord[];

Property Value

OneNote.InkWord[]

Method Details

getItem(index)

Gets a InkWord object by ID or by its index in the collection. Read-only.

getItem(index: number | string): OneNote.InkWord;

Parameters

index

number | string

The ID of the InkWord object, or the index location of the InkWord object in the collection.

Returns

OneNote.InkWord

Remarks

[ API set: OneNoteApi 1.1 ]

getItemAt(index)

Gets a InkWord on its position in the collection.

getItemAt(index: number): OneNote.InkWord;

Parameters

index

number

Index value of the object to be retrieved. Zero-indexed.

Returns

OneNote.InkWord

Remarks

[ API set: OneNoteApi 1.1 ]

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.InkWordCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.InkWordCollection;

Parameters

options

OneNote.Interfaces.InkWordCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

OneNote.InkWordCollection

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.InkWordCollection;

Parameters

propertyNames

string | string[]

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

Returns

OneNote.InkWordCollection

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?: OfficeExtension.LoadOption): OneNote.InkWordCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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.InkWordCollection

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.InkWordCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkWordCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): OneNote.Interfaces.InkWordCollectionData;

Returns

OneNote.Interfaces.InkWordCollectionData

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.InkWordCollection;

Returns

OneNote.InkWordCollection

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.InkWordCollection;

Returns

OneNote.InkWordCollection