OneNote.InkAnalysisWord class
Represents ink analysis data for an identified word formed by ink strokes.
- Extends
Remarks
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 InkAnalysisWord object. Read-only. |
| language |
The id of the recognized language in this inkAnalysisWord. Read-only. |
| line | Reference to the parent InkAnalysisLine. Read-only. |
| stroke |
Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only. |
| word |
The words that were recognized in this ink word, in order of likelihood. Read-only. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for |
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
id
Gets the ID of the InkAnalysisWord object. Read-only.
readonly id: string;Property Value
string
Remarks
languageId
The id of the recognized language in this inkAnalysisWord. Read-only.
readonly languageId: string;Property Value
string
Remarks
line
Reference to the parent InkAnalysisLine. Read-only.
readonly line: OneNote.InkAnalysisLine;Property Value
Remarks
strokePointers
Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only.
readonly strokePointers: OneNote.InkStrokePointer[];Property Value
Remarks
wordAlternates
The words that were recognized in this ink word, in order of likelihood. Read-only.
readonly wordAlternates: string[];Property Value
string[]
Remarks
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.InkAnalysisWordLoadOptions): OneNote.InkAnalysisWord;Parameters
Provides options for which properties of the object to load.
Returns
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.InkAnalysisWord;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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.InkAnalysisWord;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
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.InkAnalysisWordUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- OneNote.Interfaces.InkAnalysisWordUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: OneNote.InkAnalysisWord): void;Parameters
- properties
- OneNote.InkAnalysisWord
Returns
void
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 is passed to it.) Whereas the original OneNote.InkAnalysisWord object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkAnalysisWordData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): OneNote.Interfaces.InkAnalysisWordData;Returns
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 are 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 needed to have added the object to the tracked object collection when the object was first created.
track(): OneNote.InkAnalysisWord;Returns
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 will need to call context.sync() before the memory release takes effect.
untrack(): OneNote.InkAnalysisWord;Returns
Office Add-ins