OneNote.FloatingInk class
Represents a group of 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 FloatingInk object. Read-only. |
| ink |
Gets the strokes of the FloatingInk object. Read-only. |
| page |
Gets the PageContent parent of the FloatingInk object. 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 |
| 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 FloatingInk object. Read-only.
readonly id: string;Property Value
string
Remarks
inkStrokes
Gets the strokes of the FloatingInk object. Read-only.
readonly inkStrokes: OneNote.InkStrokeCollection;Property Value
Remarks
pageContent
Gets the PageContent parent of the FloatingInk object. Read-only.
readonly pageContent: OneNote.PageContent;Property Value
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.FloatingInkLoadOptions): OneNote.FloatingInk;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.FloatingInk;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
await OneNote.run(async (context) => {
// Gets the active page.
const page = context.application.getActivePage();
const contents = page.contents;
// Load page contents and their types.
page.load('contents/type');
await context.sync();
// Load every ink content.
$.each(contents.items, function(i, content) {
if (content.type == "Ink")
{
content.load('ink/id');
}
});
await context.sync();
// Log ID of every ink content.
$.each(contents.items, function(i, content) {
if (content.type == "Ink")
{
console.log(content.ink.id);
}
});
});
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.FloatingInk;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
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.FloatingInk object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.FloatingInkData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): OneNote.Interfaces.FloatingInkData;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.FloatingInk;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.FloatingInk;Returns
Office Add-ins