OneNote.Outline class

Пакет:

onenote

Представляет контейнер для объектов Paragraph.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор объекта Outline.
pageContent	Получает объект PageContent, содержащий объект Outline. Этот объект определяет положение объекта Outline на странице.
paragraphs	Получает коллекцию объектов Paragraph в объекте Outline.

Методы

appendHtml(html)	Добавляет указанный HTML в нижнюю часть объекта Outline.
appendImage(base64EncodedImage, width, height)	Добавляет указанное изображение в нижнюю часть объекта Outline.
appendRichText(paragraphText)	Добавляет указанный текст в нижнюю часть объекта Outline.
appendTable(rowCount, columnCount, values)	Добавляет таблицу с указанным количеством строк и столбцов в нижнюю часть объекта Outline.
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

Получает идентификатор объекта Outline.

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

pageContent

Получает объект PageContent, содержащий объект Outline. Этот объект определяет положение объекта Outline на странице.

readonly pageContent: OneNote.PageContent;

Значение свойства

OneNote.PageContent

Комментарии

[ Набор API: OneNoteApi 1.1 ]

paragraphs

Получает коллекцию объектов Paragraph в объекте Outline.

readonly paragraphs: OneNote.ParagraphCollection;

Значение свойства

OneNote.ParagraphCollection

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Сведения о методе

appendHtml(html)

Добавляет указанный HTML в нижнюю часть объекта Outline.

appendHtml(html: string): void;

Параметры

html

string

Строка HTML, которую необходимо добавить. См. раздел Поддерживаемый HTML для API JavaScript надстроек OneNote.

Возвращаемое значение

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)

Добавляет указанное изображение в нижнюю часть объекта Outline.

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)

Добавляет указанный текст в нижнюю часть объекта Outline.

appendRichText(paragraphText: string): OneNote.RichText;

Параметры

paragraphText

string

Строка HTML, которую необходимо добавить.

Возвращаемое значение

OneNote.RichText

Комментарии

[ Набор API: OneNoteApi 1.1 ]

appendTable(rowCount, columnCount, values)

Добавляет таблицу с указанным количеством строк и столбцов в нижнюю часть объекта Outline.

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