OneNote.Outline class
Представляет контейнер для объектов Paragraph.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Получает идентификатор объекта Outline. |
| page |
Получает объект PageContent, содержащий объект Outline. Этот объект определяет положение объекта Outline на странице. |
| paragraphs | Получает коллекцию объектов Paragraph в объекте Outline. |
Методы
| append |
Добавляет указанный HTML в нижнюю часть объекта Outline. |
| append |
Добавляет указанное изображение в нижнюю часть объекта Outline. |
| append |
Добавляет указанный текст в нижнюю часть объекта Outline. |
| append |
Добавляет таблицу с указанным количеством строк и столбцов в нижнюю часть объекта Outline. |
| is |
Проверьте, является ли структура заголовком. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Получает идентификатор объекта Outline.
readonly id: string;Значение свойства
string
Комментарии
pageContent
Получает объект PageContent, содержащий объект Outline. Этот объект определяет положение объекта Outline на странице.
readonly pageContent: OneNote.PageContent;Значение свойства
Комментарии
paragraphs
Получает коллекцию объектов Paragraph в объекте Outline.
readonly paragraphs: OneNote.ParagraphCollection;Значение свойства
Комментарии
Сведения о методе
appendHtml(html)
Добавляет указанный HTML в нижнюю часть объекта Outline.
appendHtml(html: string): void;Параметры
- html
-
string
Строка HTML, которую необходимо добавить. См. раздел "Поддерживаемый HTML" для API JavaScript надстроек OneNote.
Возвращаемое значение
void
Комментарии
Примеры
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)
Добавляет указанное изображение в нижнюю часть объекта Outline.
appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;Параметры
- base64EncodedImage
-
string
Строка HTML, которую необходимо добавить.
- width
-
number
Необязательный параметр. Ширина в точках. Значение по умолчанию — null, ширина изображения имеет приоритет.
- height
-
number
Необязательный параметр. Высота в точках. Значение по умолчанию — null, высота изображения имеет приоритет.
Возвращаемое значение
Комментарии
appendRichText(paragraphText)
Добавляет указанный текст в нижнюю часть объекта Outline.
appendRichText(paragraphText: string): OneNote.RichText;Параметры
- paragraphText
-
string
Строка HTML, которую необходимо добавить.
Возвращаемое значение
Комментарии
appendTable(rowCount, columnCount, values)
Добавляет таблицу с указанным количеством строк и столбцов в нижнюю часть объекта Outline.
appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;Параметры
- rowCount
-
number
Обязательно. Количество строк в таблице.
- columnCount
-
number
Обязательно. Количество столбцов в таблице.
- values
-
string[][]
Необязательный двухмерный массив. Ячейки заполняются, если в массиве указаны соответствующие строки.
Возвращаемое значение
Комментарии
Примеры
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>
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: OneNote.Interfaces.OutlineLoadOptions): OneNote.Outline;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): OneNote.Outline;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Outline;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.Outline объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как OneNote.Interfaces.OutlineData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): OneNote.Interfaces.OutlineData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.
track(): OneNote.Outline;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): OneNote.Outline;