OneNote.Notebook class

参考

包:: onenote

表示一个 OneNote 笔记本。笔记本包含分区组合和分区。

Extends: OfficeExtension.ClientObject

注解

属性

baseUrl	此笔记本所在的站点的 URL。只读
clientUrl	笔记本的客户端 URL。只读
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取笔记本的 ID。只读。
isVirtual	如此如果笔记本不是由用户创建 (，即“错放分区”) 。只读
name	获取笔记本的名称。只读。
sectionGroups	笔记本中的分区组。只读
sections	笔记本中的分区。只读

方法

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

属性详细信息

baseUrl

此笔记本所在的站点的 URL。只读

readonly baseUrl: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

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 ]

isVirtual

如此如果笔记本不是由用户创建 (，即“错放分区”) 。只读

readonly isVirtual: boolean;

属性值

boolean

注解

[ API 集：OneNoteApi 1.2 ]

name

获取笔记本的名称。只读。

readonly name: string;

属性值

string

注解

[ 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(name)

添加新分区至笔记本结尾。

addSection(name: string): OneNote.Section;

参数

name: string

新节的名称。

OneNote.Section

注解

[ API 集：OneNoteApi 1.1 ]

示例

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

    // Gets the active notebook.
    const notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section.
    const section = notebook.addSection("Sample section");
    
    // Queue a command to load the new section. This example reads the name property later.
    section.load("name");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("New section name is " + section.name);
});

addSectionGroup(name)

将新的分区组添加到笔记本结尾。

addSectionGroup(name: string): OneNote.SectionGroup;

参数

name: string

新节的名称。

OneNote.SectionGroup

注解

[ API 集：OneNoteApi 1.1 ]

示例

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

    // Gets the active notebook.
    const notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section group.
    const sectionGroup = notebook.addSectionGroup("Sample section group");

    // Queue a command to load the new section group.
    sectionGroup.load();

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("New section group name is " + sectionGroup.name);
});

getRestApiId()

获取 REST API ID。

getRestApiId(): OfficeExtension.ClientResult<string>;

OfficeExtension.ClientResult<string>

注解

[ API 集：OneNoteApi 1.1 ]

示例

await OneNote.run(async (context) => {
    // Get the current notebook.
    const notebook = context.application.getActiveNotebook();
    const restApiId = notebook.getRestApiId();

    await context.sync();
    console.log("The REST API ID is " + restApiId.value);
    // Note that the REST API ID isn't all you need to interact with the OneNote REST API.
    // This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
    // For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
    // according to the OneNote Development Blog.
    // https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

load(options)

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

load(options?: OneNote.Interfaces.NotebookLoadOptions): OneNote.Notebook;

参数

options: OneNote.Interfaces.NotebookLoadOptions

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

OneNote.Notebook

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

OneNote.Notebook

示例

await OneNote.run(async (context) => {
        
    // Get the current notebook.
    const notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('baseUrl');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("Base url: " + notebook.baseUrl);
    // This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
    // This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
    // https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

load(propertyNamesAndPaths)

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

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

参数

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

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

OneNote.Notebook

toJSON()

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

toJSON(): OneNote.Interfaces.NotebookData;

OneNote.Interfaces.NotebookData

track()

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

track(): OneNote.Notebook;

OneNote.Notebook

untrack()

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

untrack(): OneNote.Notebook;

OneNote.Notebook

通过

OneNote.Notebook class

注解

属性

方法

属性详细信息

baseUrl

属性值

注解

clientUrl

属性值

注解

context

属性值

id

属性值

注解

isVirtual

属性值

注解

name

属性值

注解

sectionGroups

属性值

注解

sections

属性值

注解

方法详细信息

addSection(name)

参数

返回

注解

示例

addSectionGroup(name)

参数

返回

注解

示例

getRestApiId()

返回

注解

示例

load(options)

参数

返回

load(propertyNames)

参数

返回

示例

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源