OneNote.RichText class
表示 Paragraph 中的 RichText 对象。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取 RichText 对象的 ID。 |
| language |
文本的语言 ID。 |
| paragraph | 获取包含 RichText 对象的 Paragraph 对象。 |
| style | 获取 RichText 对象的文本样式。 只读。 |
| text | 获取 RichText 对象的文本内容。 只读。 |
方法
| get |
获取 RTF 格式的 HTML。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
属性详细信息
context
id
languageId
paragraph
获取包含 RichText 对象的 Paragraph 对象。
readonly paragraph: OneNote.Paragraph;属性值
注解
style
获取 RichText 对象的文本样式。 只读。
readonly style: OneNote.ParagraphStyle;属性值
注解
text
方法详细信息
getHtml()
获取 RTF 格式的 HTML。
getHtml(): OfficeExtension.ClientResult<string>;返回
OfficeExtension.ClientResult<string>
格式文本的 html
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: OneNote.Interfaces.RichTextLoadOptions): OneNote.RichText;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): OneNote.RichText;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
示例
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Get the first PageContent on the page, and then get its outline's paragraphs.
const outlinePageContents = pageContents.getItem(0);
let paragraphs = outlinePageContents.outline.paragraphs;
const richTextParagraphs = paragraphs.items;
// Queue a command to load the id and type of each page content in the outline.
pageContents.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Load all page contents of type Outline.
$.each(pageContents.items, function(index, pageContent) {
if(pageContent.type == 'Outline')
{
pageContent.load('outline,outline/paragraphs,outline/paragraphs/type');
outlinePageContents.push(pageContent);
}
});
await context.sync();
// Load all rich text paragraphs across outlines.
$.each(outlinePageContents, function(index, outlinePageContent) {
const outline = outlinePageContent.outline;
paragraphs = paragraphs.concat(outline.paragraphs.items);
});
$.each(paragraphs, function(index, paragraph) {
if(paragraph.type == 'RichText')
{
richTextParagraphs.push(paragraph);
paragraph.load("id,richText/text");
}
});
await context.sync();
// Display all rich text paragraphs to the console.
$.each(richTextParagraphs, function(index, richTextParagraph) {
const richText = richTextParagraph.richText;
console.log(
"Paragraph found with richtext content : " +
richText.text + " and richtext id : " + richText.id);
});
await context.sync();
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.RichText;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始OneNote.RichText对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.RichTextData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): OneNote.Interfaces.RichTextData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。
track(): OneNote.RichText;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): OneNote.RichText;