OneNote.SectionCollection class

Ссылка

Пакет:: onenote

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

Extends: OfficeExtension.ClientObject

Свойства

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

Методы

getByName(name)	Получает коллекцию объектов Section с указанным именем.
getItem(index)	Получает объект Section по его идентификатору или индексу в коллекции. Только для чтения.
getItemAt(index)	Получает объект Section по его позиции в коллекции.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `OneNote.SectionCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.SectionCollectionData`), который содержит массив "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.Section[];

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

OneNote.Section[]

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

getByName(name)

Получает коллекцию объектов Section с указанным именем.

getByName(name: string): OneNote.SectionCollection;

Параметры

name: string

Имя раздела.

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

OneNote.SectionCollection

Примеры

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

    // Get the sections in the current notebook.
    const sections = context.application.getActiveNotebook().sections;

    // Queue a command to load the sections.
    // For best performance, request specific properties.
    sections.load("id"); 
    
    // Get the sections with the specified name.
    const groceriesSections = sections.getByName("Groceries");
    
    // Queue a command to load the sections with the specified name.
    groceriesSections.load("id,name");

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

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

getItem(index)

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

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

Параметры

index: number | string

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

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

OneNote.Section

getItemAt(index)

Получает объект Section по его позиции в коллекции.

getItemAt(index: number): OneNote.Section;

Параметры

index: number

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

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

OneNote.Section

load(options)

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

load(options?: OneNote.Interfaces.SectionCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionCollection;

Параметры

options: OneNote.Interfaces.SectionCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

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

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

OneNote.SectionCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

OneNote.SectionCollection

Примеры

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

    // Get the sections in the current notebook.
    const sections = context.application.getActiveNotebook().sections;

    // Queue a command to load the sections.
    // For best performance, request specific properties.
    sections.load("name"); 

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Iterate through the collection or access items individually by index, for example: sections.items[0]
    $.each(sections.items, function(index, section) {
        if (section.name === "Homework") {
            section.addPage("Biology");
            section.addPage("Spanish");
            section.addPage("Computer Science");
        }
    });
    await context.sync();
});

load(propertyNamesAndPaths)

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

OneNote.SectionCollection

toJSON()

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

toJSON(): OneNote.Interfaces.SectionCollectionData;

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

OneNote.Interfaces.SectionCollectionData

track()

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

track(): OneNote.SectionCollection;

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

OneNote.SectionCollection

untrack()

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

untrack(): OneNote.SectionCollection;

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

OneNote.SectionCollection

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

OneNote.SectionCollection class

Комментарии

Свойства

Методы

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

context

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

count

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

Комментарии

items

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

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

getByName(name)

Параметры

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

Комментарии

Примеры

getItem(index)

Параметры

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

Комментарии

getItemAt(index)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

track()

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

untrack()

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

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

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