OneNote.NotebookCollection class
Представляет коллекцию записных книжек.
- Extends
Комментарии
Свойства
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
count | Возвращает количество записных книжек в коллекции. Только для чтения. |
items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
get |
Получает коллекцию записных книжек с указанным именем, открытую в экземпляре приложения. |
get |
Получает записную книжку по ее идентификатору или индексу в коллекции. Только для чтения. |
get |
Получает записную книжку по ее позиции в коллекции. |
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
toJSON() | Переопределяет метод JavaScript |
track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для |
untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
count
Возвращает количество записных книжек в коллекции. Только для чтения.
readonly count: number;
Значение свойства
number
Комментарии
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: OneNote.Notebook[];
Значение свойства
Сведения о методе
getByName(name)
Получает коллекцию записных книжек с указанным именем, открытую в экземпляре приложения.
getByName(name: string): OneNote.NotebookCollection;
Параметры
- name
-
string
Имя записной книжки.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Get the notebooks that are open in the application instance and have the specified name.
const notebooks = context.application.notebooks.getByName("Homework");
// Queue a command to load the notebooks.
// For best performance, request specific properties.
notebooks.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.
// For example: notebooks.items[0]
if (notebooks.items.length > 0) {
console.log("Notebook name: " + notebooks.items[0].name);
console.log("Notebook ID: " + notebooks.items[0].id);
}
});
getItem(index)
Получает записную книжку по ее идентификатору или индексу в коллекции. Только для чтения.
getItem(index: number | string): OneNote.Notebook;
Параметры
- index
-
number | string
Идентификатор записной книжки или расположение индекса записной книжки в коллекции.
Возвращаемое значение
Комментарии
getItemAt(index)
Получает записную книжку по ее позиции в коллекции.
getItemAt(index: number): OneNote.Notebook;
Параметры
- index
-
number
Значение индекса получаемого объекта. Используется нулевой индекс.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: OneNote.Interfaces.NotebookCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.NotebookCollection;
Параметры
Предоставляет параметры свойств загружаемого объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): OneNote.NotebookCollection;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
await OneNote.run(async (context) => {
// Get the notebooks that are open in the application instance and have the specified name.
const notebooks = context.application.notebooks.getByName("Homework");
// Queue a command to load the notebooks.
// For best performance, request specific properties.
notebooks.load("id");
// 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: notebooks.items[0]
$.each(notebooks.items, function(index, notebook) {
notebook.addSection("Biology");
notebook.addSection("Spanish");
notebook.addSection("Computer Science");
});
await context.sync();
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection;
Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный OneNote.NotebookCollection
объект является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.NotebookCollectionData
), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.
toJSON(): OneNote.Interfaces.NotebookCollectionData;
Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject)
. Если вы используете этот объект в вызовах .sync
и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
track(): OneNote.NotebookCollection;
Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject)
. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync()
до того, как выпуск памяти вступит в силу.
untrack(): OneNote.NotebookCollection;
Возвращаемое значение
Office Add-ins
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по