OneNote.InkAnalysisWord class

包:

onenote

表示墨迹笔划形成的已识别字词的墨迹分析数据。

Extends

OfficeExtension.ClientObject

注解

[ API 集：OneNoteApi 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取 InkAnalysisWord 对象的 ID。 只读。
languageId	此 inkAnalysisWord 中已识别语言的 ID。 只读。
line	对父级 InkAnalysisLine 的引用。 只读。
strokePointers	对已识别为此墨迹分析字词一部分的墨迹笔划的弱引用。 只读。
wordAlternates	按照可能性的顺序，已在此墨迹字词中识别的字词。 只读。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 OneNote.InkAnalysisWord 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.InkAnalysisWordData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 的 context.trackedObjects.add(thisObject)简写。 如果跨 .sync 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 的 context.trackedObjects.remove(thisObject)简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存释放生效之前，需要调用 。context.sync()

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

OneNote.RequestContext

id

获取 InkAnalysisWord 对象的 ID。 只读。

readonly id: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

languageId

此 inkAnalysisWord 中已识别语言的 ID。 只读。

readonly languageId: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

line

对父级 InkAnalysisLine 的引用。 只读。

readonly line: OneNote.InkAnalysisLine;

属性值

OneNote.InkAnalysisLine

注解

[ API 集：OneNoteApi 1.1 ]

strokePointers

对已识别为此墨迹分析字词一部分的墨迹笔划的弱引用。 只读。

readonly strokePointers: OneNote.InkStrokePointer[];

属性值

OneNote.InkStrokePointer[]

注解

[ API 集：OneNoteApi 1.1 ]

wordAlternates

按照可能性的顺序，已在此墨迹字词中识别的字词。 只读。

readonly wordAlternates: string[];

属性值

string[]

注解

[ API 集：OneNoteApi 1.1 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: OneNote.Interfaces.InkAnalysisWordLoadOptions): OneNote.InkAnalysisWord;

参数

options

OneNote.Interfaces.InkAnalysisWordLoadOptions

提供要加载对象的属性的选项。

返回

OneNote.InkAnalysisWord

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

OneNote.InkAnalysisWord

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

OneNote.InkAnalysisWord

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.InkAnalysisWordUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties

OneNote.Interfaces.InkAnalysisWordUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: OneNote.InkAnalysisWord): void;

参数

properties

OneNote.InkAnalysisWord

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 OneNote.InkAnalysisWord 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.InkAnalysisWordData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): OneNote.Interfaces.InkAnalysisWordData;

返回

OneNote.Interfaces.InkAnalysisWordData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 的 context.trackedObjects.add(thisObject)简写。 如果跨 .sync 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。

track(): OneNote.InkAnalysisWord;

返回

OneNote.InkAnalysisWord

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 的 context.trackedObjects.remove(thisObject)简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存释放生效之前，需要调用 。context.sync()

untrack(): OneNote.InkAnalysisWord;

返回

OneNote.InkAnalysisWord