OneNote.PageContent class
表示在页面上包含顶级内容类型的地区，例如 Outline 或 Image。 可对 PageContent 对象分配一个 XY 位置。
注解
使用方
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取 PageContent 对象的 ID。 |
| image | 获取 PageContent 对象中的 Image。 如果 PageContentType 不为 Image，则引发异常。 |
| ink | 获取 PageContent 对象中的 Ink。 如果 PageContentType 不为 Ink，则引发异常。 |
| left | 获取或设置 PageContent 对象的左边（X 轴）位置。 |
| outline | 获取 PageContent 对象中的 Outline。 如果 PageContentType 不为 Outline，则引发异常。 |
| parent |
获取包含 PageContent 对象的页面。 |
| top | 获取或设置 PageContent 对象的顶部（Y 轴）位置。 |
| type | 获取 PageContent 对象的类型。 |
方法
| delete() | 删除 PageContent 对象。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
context
id
image
获取 PageContent 对象中的 Image。 如果 PageContentType 不为 Image，则引发异常。
readonly image: OneNote.Image;属性值
注解
ink
获取 PageContent 对象中的 Ink。 如果 PageContentType 不为 Ink，则引发异常。
readonly ink: OneNote.FloatingInk;属性值
注解
left
outline
获取 PageContent 对象中的 Outline。 如果 PageContentType 不为 Outline，则引发异常。
readonly outline: OneNote.Outline;属性值
注解
parentPage
top
type
获取 PageContent 对象的类型。
readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";属性值
OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"
注解
方法详细信息
delete()
删除 PageContent 对象。
delete(): void;返回
void
注解
示例
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;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): OneNote.PageContent;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.PageContent;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
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;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。
track(): OneNote.PageContent;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): OneNote.PageContent;