OneNote.Outline class

参考

包:: onenote

表示 Paragraph 对象的容器。

Extends: OfficeExtension.ClientObject

注解

属性

context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取边框对象的 ID。只读。
pageContent	获取包含边框的 PageContent 对象。此对象定义页面上 Outline 的位置。只读。
paragraphs	获取“边框”中 Paragraph 对象的集合。只读。

方法

appendHtml(html)	将指定的 HTML 添加到“边框”的底部。
appendImage(base64EncodedImage, width, height)	将指定的图像添加到“边框”的底部。
appendRichText(paragraphText)	将指定的文本添加到“边框”的底部。
appendTable(rowCount, columnCount, values)	将具有指定行数和列数的表格添加到边框的底部。
isTitle()	检查大纲是否为标题大纲。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，反过来，调用`toJSON`传递给它的对象的方法。) 而原始 OneNote.Outline 对象是 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `OneNote.Interfaces.OutlineData`) ，该对象包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是的 `context.trackedObjects.add(thisObject)`简写。如果跨 `.sync` 调用和在“.run”批处理的顺序执行之外使用此对象，并在对对象设置属性或调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪的对象集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是的 `context.trackedObjects.remove(thisObject)`简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存释放生效之前，需要调用。`context.sync()`

属性详细信息

context

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

context: RequestContext;

属性值

OneNote.RequestContext

id

获取边框对象的 ID。只读。

readonly id: string;

属性值

string

注解

[ API 集：OneNoteApi 1.1 ]

pageContent

获取包含边框的 PageContent 对象。此对象定义页面上 Outline 的位置。只读。

readonly pageContent: OneNote.PageContent;

属性值

OneNote.PageContent

注解

[ API 集：OneNoteApi 1.1 ]

paragraphs

获取“边框”中 Paragraph 对象的集合。只读。

readonly paragraphs: OneNote.ParagraphCollection;

属性值

OneNote.ParagraphCollection

注解

[ API 集：OneNoteApi 1.1 ]

方法详细信息

appendHtml(html)

将指定的 HTML 添加到“边框”的底部。

appendHtml(html: string): void;

参数

html: string

要追加的 HTML 字符串。请参阅 OneNote 加载项 JavaScript API 支持的 HTML 。

void

注解

[ API 集：OneNoteApi 1.1 ]

示例

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
    {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendHtml("<p>new paragraph</p>");

        // Run the queued commands.
        await context.sync();
    }
});

appendImage(base64EncodedImage, width, height)

将指定的图像添加到“边框”的底部。

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

参数

base64EncodedImage: string

要追加的 HTML 字符串。

width: number

可选。以磅为单位的宽度。默认值为 null，将考虑图像宽度。

height: number

可选。以磅为单位的高度。默认值为 null，将考虑图像高度。

OneNote.Image

注解

[ API 集：OneNoteApi 1.1 ]

appendRichText(paragraphText)

将指定的文本添加到“边框”的底部。

appendRichText(paragraphText: string): OneNote.RichText;

参数

paragraphText: string

要追加的 HTML 字符串。

OneNote.RichText

注解

[ API 集：OneNoteApi 1.1 ]

appendTable(rowCount, columnCount, values)

将具有指定行数和列数的表格添加到边框的底部。

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

参数

rowCount: number

必填。表格的行数。

columnCount: number

必填。表格的列数。

values: string[][]

可选的二维数组。如果指定数组中的对应字符串，则填充单元格。

OneNote.Table

注解

[ API 集：OneNoteApi 1.1 ]

示例

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);

        // Run the queued commands.
        await context.sync();
    }
});

isTitle()

检查大纲是否为标题大纲。

isTitle(): OfficeExtension.ClientResult<boolean>;

OfficeExtension.ClientResult<boolean>

注解

[ API 集：OneNoteApi 1.1 ]

load(options)

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

load(options?: OneNote.Interfaces.OutlineLoadOptions): OneNote.Outline;

参数

options: OneNote.Interfaces.OutlineLoadOptions

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

OneNote.Outline

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

OneNote.Outline

load(propertyNamesAndPaths)

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

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

参数

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

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

OneNote.Outline

toJSON()

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

toJSON(): OneNote.Interfaces.OutlineData;

OneNote.Interfaces.OutlineData

track()

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

track(): OneNote.Outline;

OneNote.Outline

untrack()

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

untrack(): OneNote.Outline;

OneNote.Outline

通过

OneNote.Outline class

注解

属性

方法

属性详细信息

context

属性值

id

属性值

注解

pageContent

属性值

注解

paragraphs

属性值

注解

方法详细信息

appendHtml(html)

参数

返回

注解

示例

appendImage(base64EncodedImage, width, height)

参数

返回

注解

appendRichText(paragraphText)

参数

返回

注解

appendTable(rowCount, columnCount, values)

参数

返回

注解

示例

isTitle()

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源