OneNote.RichText class
Представляет объект RichText в объекте Paragraph.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Получает идентификатор объекта RichText. |
| language |
ИД языка для текста. |
| paragraph | Получает объект Paragraph, содержащий объект RichText. |
| style | Получает стиль текста объекта RichText. Только для чтения. |
| text | Получает текстовое содержимое объекта RichText. Только для чтения. |
Методы
| get |
Получает HTML форматированного текста. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Получает идентификатор объекта RichText.
readonly id: string;Значение свойства
string
Комментарии
languageId
ИД языка для текста.
readonly languageId: string;Значение свойства
string
Комментарии
paragraph
Получает объект Paragraph, содержащий объект RichText.
readonly paragraph: OneNote.Paragraph;Значение свойства
Комментарии
style
Получает стиль текста объекта RichText. Только для чтения.
readonly style: OneNote.ParagraphStyle;Значение свойства
Комментарии
text
Получает текстовое содержимое объекта RichText. Только для чтения.
readonly text: string;Значение свойства
string
Комментарии
Сведения о методе
getHtml()
Получает 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;