OneNote.PageContentCollection class
Представляет содержимое страницы в виде коллекции объектов PageContent.
- Extends
Комментарии
Свойства
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
count | Возвращает количество единиц содержимого страницы в коллекции. Только для чтения. |
items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
get |
Получает объект PageContent по его идентификатору или индексу в коллекции. Только для чтения. |
get |
Получает объект PageContent по его позиции в коллекции. |
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
toJSON() | Переопределяет метод JavaScript |
track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для |
untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
count
Возвращает количество единиц содержимого страницы в коллекции. Только для чтения.
readonly count: number;
Значение свойства
number
Комментарии
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: OneNote.PageContent[];
Значение свойства
Сведения о методе
getItem(index)
Получает объект PageContent по его идентификатору или индексу в коллекции. Только для чтения.
getItem(index: number | string): OneNote.PageContent;
Параметры
- index
-
number | string
Идентификатор объекта PageContent или расположение индекса объекта PageContent в коллекции.
Возвращаемое значение
Комментарии
getItemAt(index)
Получает объект PageContent по его позиции в коллекции.
getItemAt(index: number): OneNote.PageContent;
Параметры
- index
-
number
Значение индекса получаемого объекта. Используется нулевой индекс.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
const page = context.application.getActivePage();
const pageContents = page.contents;
const firstPageContent = pageContents.getItemAt(0);
firstPageContent.load('type');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("The first page content item is of type: " + firstPageContent.type);
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: OneNote.Interfaces.PageContentCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.PageContentCollection;
Параметры
- options
-
OneNote.Interfaces.PageContentCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств загружаемого объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): OneNote.PageContentCollection;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Queue a command to load the type of each pageContent.
pageContents.load("type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
$.each(pageContents.items, function(index, pageContent) {
console.log("PageContent type: " + pageContent.type);
});
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection;
Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный OneNote.PageContentCollection
объект является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.PageContentCollectionData
), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.
toJSON(): OneNote.Interfaces.PageContentCollectionData;
Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject)
. Если вы используете этот объект в вызовах .sync
и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
track(): OneNote.PageContentCollection;
Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject)
. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync()
до того, как выпуск памяти вступит в силу.
untrack(): OneNote.PageContentCollection;
Возвращаемое значение
Office Add-ins
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по