OneNote.SectionGroup class

参考

包:: onenote

表示 OneNote 分区组。分区组可包含分区和其他分区组。

Extends: OfficeExtension.ClientObject

注解

属性

clientUrl	分区组的客户端 url。只读
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取分区组的 ID。只读。
name	获取分区组的名称。只读。
notebook	获取包含分区组的笔记本。只读。
parentSectionGroup	获取包含分区组的分区组。如果分区组是笔记本的直接子级，则引发 ItemNotFound。只读。
parentSectionGroupOrNull	获取包含分区组的分区组。如果分区组是笔记本的直接子级，则返回 null。只读。
sectionGroups	分区组中的分区组集合。只读
sections	分区组中的分区集合。只读

方法

addSection(title)	将新分区添加至分区组结尾。
addSectionGroup(name)	将新的分区组添加至此 sectionGroup 结尾。
getRestApiId()	获取 REST API ID。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，依次调用`toJSON`传递给它的对象的方法。) 而原始 OneNote.SectionGroup 对象是 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `OneNote.Interfaces.SectionGroupData`) ，该对象包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是的 `context.trackedObjects.add(thisObject)`简写。如果跨 `.sync` 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是的 `context.trackedObjects.remove(thisObject)`简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存释放生效之前，需要调用。`context.sync()`

属性详细信息

clientUrl

分区组的客户端 url。只读

readonly clientUrl: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

context

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

context: RequestContext;

属性值

OneNote.RequestContext

id

获取分区组的 ID。只读。

readonly id: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

name

获取分区组的名称。只读。

readonly name: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

notebook

获取包含分区组的笔记本。只读。

readonly notebook: OneNote.Notebook;

属性值

OneNote.Notebook

注解

[ API 集：OneNoteApi 1.1 ]

parentSectionGroup

获取包含分区组的分区组。如果分区组是笔记本的直接子级，则引发 ItemNotFound。只读。

readonly parentSectionGroup: OneNote.SectionGroup;

属性值

OneNote.SectionGroup

注解

[ API 集：OneNoteApi 1.1 ]

parentSectionGroupOrNull

获取包含分区组的分区组。如果分区组是笔记本的直接子级，则返回 null。只读。

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

属性值

OneNote.SectionGroup

注解

[ API 集：OneNoteApi 1.1 ]

sectionGroups

分区组中的分区组集合。只读

readonly sectionGroups: OneNote.SectionGroupCollection;

属性值

OneNote.SectionGroupCollection

注解

[ API 集：OneNoteApi 1.1 ]

sections

分区组中的分区集合。只读

readonly sections: OneNote.SectionCollection;

属性值

OneNote.SectionCollection

注解

[ API 集：OneNoteApi 1.1 ]

方法详细信息

addSection(title)

将新分区添加至分区组结尾。

addSection(title: string): OneNote.Section;

参数

title: string

新节的名称。

OneNote.Section

注解

[ API 集：OneNoteApi 1.1 ]

示例

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

新节的名称。

OneNote.SectionGroup

注解

[ API 集：OneNoteApi 1.1 ]

示例

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>

注解

[ API 集：OneNoteApi 1.1 ]

load(options)

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

load(options?: OneNote.Interfaces.SectionGroupLoadOptions): OneNote.SectionGroup;

参数

options: OneNote.Interfaces.SectionGroupLoadOptions

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

OneNote.SectionGroup

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

OneNote.SectionGroup

示例

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 一个逗号分隔的字符串，指定要加载的导航属性。

OneNote.SectionGroup

toJSON()

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

toJSON(): OneNote.Interfaces.SectionGroupData;

OneNote.Interfaces.SectionGroupData

track()

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

track(): OneNote.SectionGroup;

OneNote.SectionGroup

untrack()

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

untrack(): OneNote.SectionGroup;

OneNote.SectionGroup

通过

OneNote.SectionGroup class

注解

属性

方法

属性详细信息

clientUrl

属性值

注解

context

属性值

id

属性值

注解

name

属性值

注解

notebook

属性值

注解

parentSectionGroup

属性值

注解

parentSectionGroupOrNull

属性值

注解

sectionGroups

属性值

注解

sections

属性值

注解

方法详细信息

addSection(title)

参数

返回

注解

示例

addSectionGroup(name)

参数

返回

注解

示例

getRestApiId()

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

示例

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源