OneNote.SectionGroup class
表示 OneNote 分区组。 分区组可包含分区和其他分区组。
注解
使用方
属性
| client |
分区组的客户端 URL。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取分区组的 ID。 |
| name | 获取分区组的名称。 |
| notebook | 获取包含分区组的笔记本。 |
| parent |
获取包含分区组的分区组。 如果分区组是笔记本的直接子级，则引发 ItemNotFound。 |
| parent |
获取包含分区组的分区组。 如果分区组是笔记本的直接子级，则返回 null。 |
| section |
分区组中的分区组集合。 |
| sections | 分区组中的分区集合。 |
方法
| add |
将新分区添加至分区组结尾。 |
| add |
将新的分区组添加至此 sectionGroup 结尾。 |
| get |
获取 REST API ID。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
clientUrl
context
id
name
notebook
parentSectionGroup
获取包含分区组的分区组。 如果分区组是笔记本的直接子级，则引发 ItemNotFound。
readonly parentSectionGroup: OneNote.SectionGroup;属性值
注解
parentSectionGroupOrNull
获取包含分区组的分区组。 如果分区组是笔记本的直接子级，则返回 null。
readonly parentSectionGroupOrNull: OneNote.SectionGroup;属性值
注解
sectionGroups
分区组中的分区组集合。
readonly sectionGroups: OneNote.SectionGroupCollection;属性值
注解
sections
分区组中的分区集合。
readonly sections: OneNote.SectionCollection;属性值
注解
方法详细信息
addSection(title)
将新分区添加至分区组结尾。
addSection(title: string): OneNote.Section;参数
- title
-
string
新节的名称。
返回
注解
示例
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Add a section to each section group.
$.each(sectionGroups.items, function(index, sectionGroup) {
sectionGroup.addSection("Agenda");
});
// Run the queued commands.
await context.sync();
});
addSectionGroup(name)
将新的分区组添加至此 sectionGroup 结尾。
addSectionGroup(name: string): OneNote.SectionGroup;参数
- name
-
string
新节的名称。
返回
注解
示例
await OneNote.run(async (context) => {
let sectionGroup;
let nestedSectionGroup;
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section group.
const sectionGroups = notebook.sectionGroups;
// Queue a command to load the new section group.
sectionGroups.load();
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
sectionGroup = sectionGroups.items[0];
sectionGroup.load();
await context.sync();
nestedSectionGroup = sectionGroup.addSectionGroup("Sample nested section group");
nestedSectionGroup.load();
await context.sync();
console.log("New nested section group name is " + nestedSectionGroup.name);
});
getRestApiId()
获取 REST API ID。
getRestApiId(): OfficeExtension.ClientResult<string>;返回
OfficeExtension.ClientResult<string>
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: OneNote.Interfaces.SectionGroupLoadOptions): OneNote.SectionGroup;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): OneNote.SectionGroup;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
await OneNote.run(async (context) => {
// Get the parent section group that contains the current section.
const sectionGroup = context.application.getActiveSection().parentSectionGroup;
// Queue a command to load the section group.
// For best performance, request specific properties.
sectionGroup.load("id,name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Write the properties.
console.log("Section group name: " + sectionGroup.name);
console.log("Section group ID: " + sectionGroup.id);
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.SectionGroup;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 OneNote.SectionGroup 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 OneNote.Interfaces.SectionGroupData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): OneNote.Interfaces.SectionGroupData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。
track(): OneNote.SectionGroup;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): OneNote.SectionGroup;