通过

OneNote.FloatingInk class

  • 参考
包:
onenote

表示一组墨迹笔划。

Extends
OfficeExtension.ClientObject

注解

[ API 集：OneNoteApi 1.1 ]

属性

context

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

获取 FloatingInk 对象的 ID。 只读。
inkStrokes

获取 FloatingInk 对象的笔划。 只读。
pageContent

获取 FloatingInk 对象的 PageContent 父级。 只读。

方法

load(options)

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

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

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

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

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

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

属性详细信息

context

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

context: RequestContext;

属性值

OneNote.RequestContext

id

获取 FloatingInk 对象的 ID。 只读。

readonly id: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

inkStrokes

获取 FloatingInk 对象的笔划。 只读。

readonly inkStrokes: OneNote.InkStrokeCollection;

属性值

OneNote.InkStrokeCollection

注解

[ API 集：OneNoteApi 1.1 ]

pageContent

获取 FloatingInk 对象的 PageContent 父级。 只读。

readonly pageContent: OneNote.PageContent;

属性值

OneNote.PageContent

注解

[ API 集：OneNoteApi 1.1 ]

方法详细信息

load(options)

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

load(options?: OneNote.Interfaces.FloatingInkLoadOptions): OneNote.FloatingInk;

参数

options
OneNote.Interfaces.FloatingInkLoadOptions

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

返回

OneNote.FloatingInk

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

OneNote.FloatingInk

示例

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)

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

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

参数

propertyNamesAndPaths

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

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

返回

OneNote.FloatingInk

toJSON()

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

toJSON(): OneNote.Interfaces.FloatingInkData;

返回

OneNote.Interfaces.FloatingInkData

track()

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

track(): OneNote.FloatingInk;

返回

OneNote.FloatingInk

untrack()

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

untrack(): OneNote.FloatingInk;

返回

OneNote.FloatingInk