OneNote.InkStrokeCollection class
表示 InkStroke 对象的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| count | 返回页面中的 InkStrokes 数目。 此为只读属性。 |
| items | 获取此集合中已加载的子项。 |
方法
| get |
按其在集合中的 ID 或索引获取 InkStroke 对象。 此为只读属性。 |
| get |
按其在集合中的位置获取 InkStroke。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 的 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 的 |
属性详细信息
context
count
items
方法详细信息
getItem(index)
按其在集合中的 ID 或索引获取 InkStroke 对象。 此为只读属性。
getItem(index: number | string): OneNote.InkStroke;参数
- index
-
number | string
InkStroke 对象的 ID 或集合中 InkStroke 对象的索引位置。
返回
注解
getItemAt(index)
按其在集合中的位置获取 InkStroke。
getItemAt(index: number): OneNote.InkStroke;参数
- index
-
number
要检索的对象的索引值。 从零开始编制索引。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: OneNote.Interfaces.InkStrokeCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.InkStrokeCollection;参数
- options
-
OneNote.Interfaces.InkStrokeCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): OneNote.InkStrokeCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始OneNote.InkStrokeCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.InkStrokeCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): OneNote.Interfaces.InkStrokeCollectionData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 的 context.trackedObjects.add(thisObject)简写。 如果跨 .sync 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。
track(): OneNote.InkStrokeCollection;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 的 context.trackedObjects.remove(thisObject)简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存释放生效之前，需要调用 。context.sync()
untrack(): OneNote.InkStrokeCollection;