onenote package

类

OneNote.Application	表示包含所有全局可寻址的 OneNote 对象的顶级对象，例如笔记本、活动笔记本和活动分区。
OneNote.FloatingInk	表示一组墨迹笔划。
OneNote.Image	表示 Image。 Image 可以是 PageContent 对象或 Paragraph 对象的直接子级。
OneNote.InkAnalysis	表示一组给定墨迹笔划的墨迹分析数据。
OneNote.InkAnalysisLine	表示墨迹笔划形成的已识别文本行的墨迹分析数据。
OneNote.InkAnalysisLineCollection	表示 InkAnalysisLine 对象的集合。
OneNote.InkAnalysisParagraph	表示墨迹笔划形成的已识别段落的墨迹分析数据。
OneNote.InkAnalysisParagraphCollection	表示 InkAnalysisParagraph 对象的集合。
OneNote.InkAnalysisWord	表示墨迹笔划形成的已识别字词的墨迹分析数据。
OneNote.InkAnalysisWordCollection	表示 InkAnalysisWord 对象的集合。
OneNote.InkStroke	表示单个墨迹笔划。
OneNote.InkStrokeCollection	表示 InkStroke 对象的集合。
OneNote.InkWord	段落字词中的墨迹容器。
OneNote.InkWordCollection	表示 InkWord 对象的集合。
OneNote.Notebook	表示一个 OneNote 笔记本。 笔记本包含分区组合和分区。
OneNote.NotebookCollection	表示笔记本的集合。
OneNote.NoteTag	段落中 NoteTag 的容器。
OneNote.Outline	表示 Paragraph 对象的容器。
OneNote.Page	表示一个 OneNote 页面。
OneNote.PageCollection	表示页面的集合。
OneNote.PageContent	表示在页面上包含顶级内容类型的地区，例如 Outline 或 Image。 可对 PageContent 对象分配一个 XY 位置。
OneNote.PageContentCollection	作为 PageContent 对象的集合，表示页面的内容。
OneNote.Paragraph	页面上可见内容的容器。 一个 Paragraph 可包含任意一个 ParagraphType 类型的内容。
OneNote.ParagraphCollection	表示 Paragraph 对象的集合。
OneNote.Point	表示墨迹笔划的单个点
OneNote.PointCollection	表示点对象的集合。
OneNote.RequestContext
OneNote.RichText	表示 Paragraph 中的 RichText 对象。
OneNote.Section	表示 OneNote 分区。 分区可包含页面。
OneNote.SectionCollection	表示分区的集合。
OneNote.SectionGroup	表示 OneNote 分区组。 分区组可包含分区和其他分区组。
OneNote.SectionGroupCollection	代表分区组的集合。
OneNote.Table	表示 OneNote 页中的表格。
OneNote.TableCell	表示 OneNote 表中的一个单元格。
OneNote.TableCellCollection	包含 TableCell 对象的集合。
OneNote.TableRow	表示表中的行。
OneNote.TableRowCollection	包含 TableRow 对象的集合。

接口

OneNote.ImageOcrData	表示通过 OCR (图像的光学字符识别) 获得的数据。
OneNote.InkStrokePointer	对墨迹笔划对象及其内容父级的弱引用。
OneNote.Interfaces.ApplicationData	一个描述通过调用 application.toJSON()返回的数据的接口。
OneNote.Interfaces.ApplicationLoadOptions	表示包含所有全局可寻址的 OneNote 对象的顶级对象，例如笔记本、活动笔记本和活动分区。
OneNote.Interfaces.ApplicationUpdateData	用于更新对象上 Application 的数据的接口，用于 application.set({ ... }).
OneNote.Interfaces.CollectionLoadOptions	提供仅加载集合成员子集的属性的方法。
OneNote.Interfaces.FloatingInkData	一个描述通过调用 floatingInk.toJSON()返回的数据的接口。
OneNote.Interfaces.FloatingInkLoadOptions	表示一组墨迹笔划。
OneNote.Interfaces.ImageData	一个描述通过调用 image.toJSON()返回的数据的接口。
OneNote.Interfaces.ImageLoadOptions	表示 Image。 Image 可以是 PageContent 对象或 Paragraph 对象的直接子级。
OneNote.Interfaces.ImageUpdateData	用于更新对象上 Image 的数据的接口，用于 image.set({ ... }).
OneNote.Interfaces.InkAnalysisData	一个描述通过调用 inkAnalysis.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisLineCollectionData	一个描述通过调用 inkAnalysisLineCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions	表示 InkAnalysisLine 对象的集合。
OneNote.Interfaces.InkAnalysisLineCollectionUpdateData	用于更新对象上 InkAnalysisLineCollection 的数据的接口，用于 inkAnalysisLineCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisLineData	一个描述通过调用 inkAnalysisLine.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisLineLoadOptions	表示墨迹笔划形成的已识别文本行的墨迹分析数据。
OneNote.Interfaces.InkAnalysisLineUpdateData	用于更新对象上 InkAnalysisLine 的数据的接口，用于 inkAnalysisLine.set({ ... }).
OneNote.Interfaces.InkAnalysisLoadOptions	表示一组给定墨迹笔划的墨迹分析数据。
OneNote.Interfaces.InkAnalysisParagraphCollectionData	一个描述通过调用 inkAnalysisParagraphCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions	表示 InkAnalysisParagraph 对象的集合。
OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData	用于更新对象上 InkAnalysisParagraphCollection 的数据的接口，用于 inkAnalysisParagraphCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisParagraphData	一个描述通过调用 inkAnalysisParagraph.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisParagraphLoadOptions	表示墨迹笔划形成的已识别段落的墨迹分析数据。
OneNote.Interfaces.InkAnalysisParagraphUpdateData	用于更新对象上 InkAnalysisParagraph 的数据的接口，用于 inkAnalysisParagraph.set({ ... }).
OneNote.Interfaces.InkAnalysisUpdateData	用于更新对象上 InkAnalysis 的数据的接口，用于 inkAnalysis.set({ ... }).
OneNote.Interfaces.InkAnalysisWordCollectionData	一个描述通过调用 inkAnalysisWordCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions	表示 InkAnalysisWord 对象的集合。
OneNote.Interfaces.InkAnalysisWordCollectionUpdateData	用于更新对象上 InkAnalysisWordCollection 的数据的接口，用于 inkAnalysisWordCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisWordData	一个描述通过调用 inkAnalysisWord.toJSON()返回的数据的接口。
OneNote.Interfaces.InkAnalysisWordLoadOptions	表示墨迹笔划形成的已识别字词的墨迹分析数据。
OneNote.Interfaces.InkAnalysisWordUpdateData	用于更新对象上 InkAnalysisWord 的数据的接口，用于 inkAnalysisWord.set({ ... }).
OneNote.Interfaces.InkStrokeCollectionData	一个描述通过调用 inkStrokeCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.InkStrokeCollectionLoadOptions	表示 InkStroke 对象的集合。
OneNote.Interfaces.InkStrokeCollectionUpdateData	用于更新对象上 InkStrokeCollection 的数据的接口，用于 inkStrokeCollection.set({ ... }).
OneNote.Interfaces.InkStrokeData	一个描述通过调用 inkStroke.toJSON()返回的数据的接口。
OneNote.Interfaces.InkStrokeLoadOptions	表示单个墨迹笔划。
OneNote.Interfaces.InkWordCollectionData	一个描述通过调用 inkWordCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.InkWordCollectionLoadOptions	表示 InkWord 对象的集合。
OneNote.Interfaces.InkWordCollectionUpdateData	用于更新对象上 InkWordCollection 的数据的接口，用于 inkWordCollection.set({ ... }).
OneNote.Interfaces.InkWordData	一个描述通过调用 inkWord.toJSON()返回的数据的接口。
OneNote.Interfaces.InkWordLoadOptions	段落字词中的墨迹容器。
OneNote.Interfaces.NotebookCollectionData	一个描述通过调用 notebookCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.NotebookCollectionLoadOptions	表示笔记本的集合。
OneNote.Interfaces.NotebookCollectionUpdateData	用于更新对象上 NotebookCollection 的数据的接口，用于 notebookCollection.set({ ... }).
OneNote.Interfaces.NotebookData	一个描述通过调用 notebook.toJSON()返回的数据的接口。
OneNote.Interfaces.NotebookLoadOptions	表示一个 OneNote 笔记本。 笔记本包含分区组合和分区。
OneNote.Interfaces.NoteTagData	一个描述通过调用 noteTag.toJSON()返回的数据的接口。
OneNote.Interfaces.NoteTagLoadOptions	段落中 NoteTag 的容器。
OneNote.Interfaces.OutlineData	一个描述通过调用 outline.toJSON()返回的数据的接口。
OneNote.Interfaces.OutlineLoadOptions	表示 Paragraph 对象的容器。
OneNote.Interfaces.PageCollectionData	一个描述通过调用 pageCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.PageCollectionLoadOptions	表示页面的集合。
OneNote.Interfaces.PageCollectionUpdateData	用于更新对象上 PageCollection 的数据的接口，用于 pageCollection.set({ ... }).
OneNote.Interfaces.PageContentCollectionData	一个描述通过调用 pageContentCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.PageContentCollectionLoadOptions	作为 PageContent 对象的集合，表示页面的内容。
OneNote.Interfaces.PageContentCollectionUpdateData	用于更新对象上 PageContentCollection 的数据的接口，用于 pageContentCollection.set({ ... }).
OneNote.Interfaces.PageContentData	一个描述通过调用 pageContent.toJSON()返回的数据的接口。
OneNote.Interfaces.PageContentLoadOptions	表示在页面上包含顶级内容类型的地区，例如 Outline 或 Image。 可对 PageContent 对象分配一个 XY 位置。
OneNote.Interfaces.PageContentUpdateData	用于更新对象上 PageContent 的数据的接口，用于 pageContent.set({ ... }).
OneNote.Interfaces.PageData	一个描述通过调用 page.toJSON()返回的数据的接口。
OneNote.Interfaces.PageLoadOptions	表示一个 OneNote 页面。
OneNote.Interfaces.PageUpdateData	用于更新对象上 Page 的数据的接口，用于 page.set({ ... }).
OneNote.Interfaces.ParagraphCollectionData	一个描述通过调用 paragraphCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.ParagraphCollectionLoadOptions	表示 Paragraph 对象的集合。
OneNote.Interfaces.ParagraphCollectionUpdateData	用于更新 ParagraphCollection 对象上的数据的接口，用于 paragraphCollection.set({ ... }).
OneNote.Interfaces.ParagraphData	一个描述通过调用 paragraph.toJSON()返回的数据的接口。
OneNote.Interfaces.ParagraphLoadOptions	页面上可见内容的容器。 一个 Paragraph 可包含任意一个 ParagraphType 类型的内容。
OneNote.Interfaces.ParagraphUpdateData	用于更新对象上 Paragraph 的数据的接口，用于 paragraph.set({ ... }).
OneNote.Interfaces.PointCollectionData	一个描述通过调用 pointCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.PointCollectionLoadOptions	表示点对象的集合。
OneNote.Interfaces.PointCollectionUpdateData	用于更新对象上 PointCollection 的数据的接口，用于 pointCollection.set({ ... }).
OneNote.Interfaces.PointData	一个描述通过调用 point.toJSON()返回的数据的接口。
OneNote.Interfaces.PointLoadOptions	表示墨迹笔划的单个点
OneNote.Interfaces.RichTextData	一个描述通过调用 richText.toJSON()返回的数据的接口。
OneNote.Interfaces.RichTextLoadOptions	表示 Paragraph 中的 RichText 对象。
OneNote.Interfaces.SectionCollectionData	一个描述通过调用 sectionCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.SectionCollectionLoadOptions	表示分区的集合。
OneNote.Interfaces.SectionCollectionUpdateData	用于更新对象上 SectionCollection 的数据的接口，用于 sectionCollection.set({ ... }).
OneNote.Interfaces.SectionData	一个描述通过调用 section.toJSON()返回的数据的接口。
OneNote.Interfaces.SectionGroupCollectionData	一个描述通过调用 sectionGroupCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.SectionGroupCollectionLoadOptions	代表分区组的集合。
OneNote.Interfaces.SectionGroupCollectionUpdateData	用于更新对象上 SectionGroupCollection 的数据的接口，用于 sectionGroupCollection.set({ ... }).
OneNote.Interfaces.SectionGroupData	一个描述通过调用 sectionGroup.toJSON()返回的数据的接口。
OneNote.Interfaces.SectionGroupLoadOptions	表示 OneNote 分区组。 分区组可包含分区和其他分区组。
OneNote.Interfaces.SectionLoadOptions	表示 OneNote 分区。 分区可包含页面。
OneNote.Interfaces.TableCellCollectionData	一个描述通过调用 tableCellCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.TableCellCollectionLoadOptions	包含 TableCell 对象的集合。
OneNote.Interfaces.TableCellCollectionUpdateData	用于更新对象上 TableCellCollection 的数据的接口，用于 tableCellCollection.set({ ... }).
OneNote.Interfaces.TableCellData	一个描述通过调用 tableCell.toJSON()返回的数据的接口。
OneNote.Interfaces.TableCellLoadOptions	表示 OneNote 表中的一个单元格。
OneNote.Interfaces.TableCellUpdateData	用于更新对象上 TableCell 的数据的接口，用于 tableCell.set({ ... }).
OneNote.Interfaces.TableData	一个描述通过调用 table.toJSON()返回的数据的接口。
OneNote.Interfaces.TableLoadOptions	表示 OneNote 页中的表格。
OneNote.Interfaces.TableRowCollectionData	一个描述通过调用 tableRowCollection.toJSON()返回的数据的接口。
OneNote.Interfaces.TableRowCollectionLoadOptions	包含 TableRow 对象的集合。
OneNote.Interfaces.TableRowCollectionUpdateData	用于更新对象上 TableRowCollection 的数据的接口，用于 tableRowCollection.set({ ... }).
OneNote.Interfaces.TableRowData	一个描述通过调用 tableRow.toJSON()返回的数据的接口。
OneNote.Interfaces.TableRowLoadOptions	表示表中的行。
OneNote.Interfaces.TableUpdateData	用于更新对象上 Table 的数据的接口，用于 table.set({ ... }).
OneNote.ParagraphInfo	列出段落的信息。

枚举

OneNote.ErrorCodes

OneNote.EventType

OneNote.InsertLocation

OneNote.ListType

OneNote.NoteTagStatus

OneNote.NoteTagType

OneNote.NumberType

OneNote.PageContentType

OneNote.ParagraphStyle

OneNote.ParagraphType

函数

OneNote.run(batch)	执行批处理脚本，该脚本使用新的请求上下文对 OneNote 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。
OneNote.run(object, batch)	执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文，对 OneNote 对象模型执行操作。
OneNote.run(objects, batch)	执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 OneNote 对象模型执行操作。

函数详细信息

OneNote.run(batch)

执行批处理脚本，该脚本使用新的请求上下文对 OneNote 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

export function run<T>(batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

参数

batch

(context: OneNote.RequestContext) => Promise<T>

一个函数，它采用 OneNote.RequestContext 并返回承诺 (通常只是“context.sync () ”的结果 ) 。 context 参数便于请求 OneNote 应用程序。 由于 Office 加载项和 OneNote 应用程序在两个不同的进程中运行，因此需要请求上下文才能从加载项获取对 OneNote 对象模型的访问权限。

返回

Promise<T>

示例

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await OneNote.run(async (context) => {
    const notebook = context.application.getActiveNotebook();
    // Interact with the OneNote notebook...
});

OneNote.run(object, batch)

执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文，对 OneNote 对象模型执行操作。

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

参数

object

OfficeExtension.ClientObject

以前创建的 API 对象。 批处理将使用与传入对象相同的请求上下文，这意味着“context.sync () ”将选取应用于对象的任何更改。

batch

(context: OneNote.RequestContext) => Promise<T>

一个函数，它采用 OneNote.RequestContext 并返回承诺 (通常只是“context.sync () ”的结果 ) 。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

返回

Promise<T>

OneNote.run(objects, batch)

执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 OneNote 对象模型执行操作。

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

参数

objects

OfficeExtension.ClientObject[]

batch

(context: OneNote.RequestContext) => Promise<T>

一个函数，它采用 OneNote.RequestContext 并返回承诺 (通常只是“context.sync () ”的结果 ) 。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

返回

Promise<T>