OneNote.Notebook class
Представляет записную книжку OneNote. Записные книжки содержат группы разделов и разделы.
- Extends
Комментарии
Свойства
base |
URL-адрес сайта, на котором находится эта записная книжка. Только чтение |
client |
URL-адрес записной книжки для клиента. Только чтение |
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
id | Получает идентификатор записной книжки. Только для чтения. |
is |
Значение true, если записная книжка не создана пользователем (т. е. "Неуместные разделы"). Только чтение |
name | Получает имя записной книжки. Только для чтения. |
section |
Группы разделов в записной книжке. Только чтение |
sections | Разделы записной книжки. Только чтение |
Методы
add |
Добавляет новый раздел в конец записной книжки. |
add |
Добавляет новую группу разделов в конец записной книжки. |
get |
Возвращает идентификатор REST API. |
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
toJSON() | Переопределяет метод JavaScript |
track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для |
untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для |
Сведения о свойстве
baseUrl
URL-адрес сайта, на котором находится эта записная книжка. Только чтение
readonly baseUrl: string;
Значение свойства
string
Комментарии
clientUrl
URL-адрес записной книжки для клиента. Только чтение
readonly clientUrl: string;
Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
id
Получает идентификатор записной книжки. Только для чтения.
readonly id: string;
Значение свойства
string
Комментарии
isVirtual
Значение true, если записная книжка не создана пользователем (т. е. "Неуместные разделы"). Только чтение
readonly isVirtual: boolean;
Значение свойства
boolean
Комментарии
name
Получает имя записной книжки. Только для чтения.
readonly name: string;
Значение свойства
string
Комментарии
sectionGroups
Группы разделов в записной книжке. Только чтение
readonly sectionGroups: OneNote.SectionGroupCollection;
Значение свойства
Комментарии
sections
Разделы записной книжки. Только чтение
readonly sections: OneNote.SectionCollection;
Значение свойства
Комментарии
Сведения о методе
addSection(name)
Добавляет новый раздел в конец записной книжки.
addSection(name: string): OneNote.Section;
Параметры
- name
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section.
const section = notebook.addSection("Sample section");
// Queue a command to load the new section. This example reads the name property later.
section.load("name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("New section name is " + section.name);
});
addSectionGroup(name)
Добавляет новую группу разделов в конец записной книжки.
addSectionGroup(name: string): OneNote.SectionGroup;
Параметры
- name
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section group.
const sectionGroup = notebook.addSectionGroup("Sample section group");
// Queue a command to load the new section group.
sectionGroup.load();
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("New section group name is " + sectionGroup.name);
});
getRestApiId()
Возвращает идентификатор REST API.
getRestApiId(): OfficeExtension.ClientResult<string>;
Возвращаемое значение
OfficeExtension.ClientResult<string>
Комментарии
Примеры
await OneNote.run(async (context) => {
// Get the current notebook.
const notebook = context.application.getActiveNotebook();
const restApiId = notebook.getRestApiId();
await context.sync();
console.log("The REST API ID is " + restApiId.value);
// Note that the REST API ID isn't all you need to interact with the OneNote REST API.
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
// according to the OneNote Development Blog.
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: OneNote.Interfaces.NotebookLoadOptions): OneNote.Notebook;
Параметры
Предоставляет параметры свойств загружаемого объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): OneNote.Notebook;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
await OneNote.run(async (context) => {
// Get the current notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('baseUrl');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Base url: " + notebook.baseUrl);
// This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
// This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Notebook;
Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный объект OneNote.Notebook является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.NotebookData
), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): OneNote.Interfaces.NotebookData;
Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject)
. Если вы используете этот объект в вызовах .sync
и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
track(): OneNote.Notebook;
Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject)
. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync()
до того, как выпуск памяти вступит в силу.
untrack(): OneNote.Notebook;
Возвращаемое значение
Office Add-ins