OneNote.PageCollection class

Ссылка

Пакет:: onenote

Представляет коллекцию страниц.

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
count	Возвращает количество страниц в коллекции. Только для чтения.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

getByTitle(title)	Возвращает коллекцию объектов Page с указанным названием.
getItem(index)	Возвращает объект Page по его идентификатору или индексу в коллекции. Только для чтения.
getItemAt(index)	Возвращает объект Page по его позиции в коллекции.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `OneNote.PageCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.PageCollectionData`), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для `context.trackedObjects.add(thisObject)`. Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для `context.trackedObjects.remove(thisObject)`. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

OneNote.RequestContext

count

Возвращает количество страниц в коллекции. Только для чтения.

readonly count: number;

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

number

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: OneNote.Page[];

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

OneNote.Page[]

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

getByTitle(title)

Возвращает коллекцию объектов Page с указанным названием.

getByTitle(title: string): OneNote.PageCollection;

Параметры

title: string

Заголовок страницы.

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

OneNote.PageCollection

Примеры

await OneNote.run(async (context) => {

    // Get all the pages in the current section.
    const allPages = context.application.getActiveSection().pages;

    // Queue a command to load the pages.
    // For best performance, request specific properties.
    allPages.load("id"); 

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Get the sections with the specified name.
    const todoPages = allPages.getByTitle("Todo list");

    // Queue a command to load the section.
    // For best performance, request specific properties.
    todoPages.load("id,title"); 

    await context.sync()

    // Iterate through the collection or access items individually by index.
    if (todoPages.items.length > 0) {
        console.log("Page title: " + todoPages.items[0].title);
        console.log("Page ID: " + todoPages.items[0].id);
    }
});

getItem(index)

Возвращает объект Page по его идентификатору или индексу в коллекции. Только для чтения.

getItem(index: number | string): OneNote.Page;

Параметры

index: number | string

Идентификатор объекта Page или расположение индекса этого объекта в коллекции.

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

OneNote.Page

getItemAt(index)

Возвращает объект Page по его позиции в коллекции.

getItemAt(index: number): OneNote.Page;

Параметры

index: number

Значение индекса получаемого объекта. Используется нулевой индекс.

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

OneNote.Page

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.PageCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.PageCollection;

Параметры

options: OneNote.Interfaces.PageCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств загружаемого объекта.

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

OneNote.PageCollection

load(propertyNames)

load(propertyNames?: string | string[]): OneNote.PageCollection;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

OneNote.PageCollection

Примеры

await OneNote.run(async (context) => {
    
    // Get the pages in the current section.
    const pages = context.application.getActiveSection().pages;
    
    // Queue a command to load the id and title for each page.
    pages.load('id,title');
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Display the properties.
    $.each(pages.items, function(index, page) {
        console.log(page.title);
        console.log(page.id);
    });
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

OneNote.PageCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.PageCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.PageCollectionData), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.

toJSON(): OneNote.Interfaces.PageCollectionData;

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

OneNote.Interfaces.PageCollectionData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.PageCollection;

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

OneNote.PageCollection

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.PageCollection;

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

OneNote.PageCollection

Поделиться через

OneNote.PageCollection class

Комментарии

Свойства

Методы

Сведения о свойстве

context

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

count

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

Комментарии

items

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

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

getByTitle(title)

Параметры

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

Комментарии

Примеры

getItem(index)

Параметры

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

Комментарии

getItemAt(index)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

track()

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

untrack()

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

Обратная связь

Дополнительные ресурсы