OneNote.PageContent class

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

context: RequestContext;

属性值

获取 PageContent 对象的 ID。

readonly id: string;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取 PageContent 对象中的 Image。 如果 PageContentType 不为 Image，则引发异常。

readonly image: OneNote.Image;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取 PageContent 对象中的 Ink。 如果 PageContentType 不为 Ink，则引发异常。

readonly ink: OneNote.FloatingInk;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取或设置 PageContent 对象的左边（X 轴）位置。

left: number;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取 PageContent 对象中的 Outline。 如果 PageContentType 不为 Outline，则引发异常。

readonly outline: OneNote.Outline;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取包含 PageContent 对象的页面。

readonly parentPage: OneNote.Page;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取或设置 PageContent 对象的顶部（Y 轴）位置。

top: number;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取 PageContent 对象的类型。

readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

属性值

注解

[ API 集：OneNoteApi 1.1 ]

删除 PageContent 对象。

delete(): void;

返回

注解

[ API 集：OneNoteApi 1.1 ]

示例

await OneNote.run(async (context) => {

    const page = context.application.getActivePage();
    const pageContents = page.contents;

    const firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (firstPageContent.isNullObject === false) {
        firstPageContent.delete();
        await context.sync();
    }
});

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

load(options?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;

参数

返回

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

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

参数

返回

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

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

参数

返回

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

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

参数

返回

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

set(properties: OneNote.PageContent): void;

参数

返回

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

toJSON(): OneNote.Interfaces.PageContentData;

返回

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

track(): OneNote.PageContent;

返回

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

untrack(): OneNote.PageContent;

返回