OneNote.PageContent class

包:

onenote

表示在页面上包含顶级内容类型的地区，例如 Outline 或 Image。 可对 PageContent 对象分配一个 XY 位置。

Extends

OfficeExtension.ClientObject

注解

[ API 集：OneNoteApi 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取 PageContent 对象的 ID。 只读。
image	获取 PageContent 对象中的 Image。 如果 PageContentType 不为 Image，则引发异常。
ink	获取 PageContent 对象中的 Ink。 如果 PageContentType 不为 Ink，则引发异常。
left	获取或设置 PageContent 对象的左边（X 轴）位置。
outline	获取 PageContent 对象中的 Outline。 如果 PageContentType 不为 Outline，则引发异常。
parentPage	获取包含 PageContent 对象的页面。 只读。
top	获取或设置 PageContent 对象的顶部（Y 轴）位置。
type	获取 PageContent 对象的类型。 只读。

方法

delete()	删除 PageContent 对象。
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.PageContent 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.PageContentData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 的 context.trackedObjects.add(thisObject)简写。 如果跨 .sync 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 的 context.trackedObjects.remove(thisObject)简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存释放生效之前，需要调用 。context.sync()

属性详细信息

context

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

context: RequestContext;

属性值

OneNote.RequestContext

id

获取 PageContent 对象的 ID。 只读。

readonly id: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

image

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

readonly image: OneNote.Image;

属性值

OneNote.Image

注解

[ API 集：OneNoteApi 1.1 ]

ink

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

readonly ink: OneNote.FloatingInk;

属性值

OneNote.FloatingInk

注解

[ API 集：OneNoteApi 1.1 ]

left

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

left: number;

属性值

number

注解

[ API 集：OneNoteApi 1.1 ]

outline

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

readonly outline: OneNote.Outline;

属性值

OneNote.Outline

注解

[ API 集：OneNoteApi 1.1 ]

parentPage

获取包含 PageContent 对象的页面。 只读。

readonly parentPage: OneNote.Page;

属性值

OneNote.Page

注解

[ API 集：OneNoteApi 1.1 ]

top

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

top: number;

属性值

number

注解

[ API 集：OneNoteApi 1.1 ]

type

获取 PageContent 对象的类型。 只读。

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

属性值

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

注解

[ API 集：OneNoteApi 1.1 ]

方法详细信息

delete()

删除 PageContent 对象。

delete(): void;

返回

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();
    }
});

load(options)

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

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

参数

options

OneNote.Interfaces.PageContentLoadOptions

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

返回

OneNote.PageContent

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

OneNote.PageContent

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

OneNote.PageContent

set(properties, options)

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

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

参数

properties

OneNote.Interfaces.PageContentUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: OneNote.PageContent): void;

参数

properties

OneNote.PageContent

返回

void

toJSON()

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

toJSON(): OneNote.Interfaces.PageContentData;

返回

OneNote.Interfaces.PageContentData

track()

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

track(): OneNote.PageContent;

返回

OneNote.PageContent

untrack()

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

untrack(): OneNote.PageContent;

返回

OneNote.PageContent