OneNote.Section class
Представляет раздел в OneNote. Разделы могут содержать страницы.
- Extends
Комментарии
Свойства
client |
URL-адрес клиента раздела. Только чтение |
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
id | Получает идентификатор объекта Section. Только для чтения. |
is |
Значение true, если этот раздел зашифрован с помощью пароля. Только чтение |
is |
Значение true, если этот раздел заблокирован. Только чтение |
name | Получает имя раздела. Только для чтения. |
notebook | Получает записную книжку, содержащую раздел. Только для чтения. |
pages | Получает коллекцию страниц в разделе. Только чтение |
parent |
Получает группу объектов, содержащую раздел. Возвращает значение ItemNotFound, если раздел является прямым потомком записной книжки. Только для чтения. |
parent |
Получает группу объектов, содержащую раздел. Возвращает значение null, если объект Section является прямым потомком объекта Notebook. Только для чтения. |
web |
URL-адрес страницы. Только чтение |
Методы
add |
Добавляет новую страницу в конец раздела. |
copy |
Копирует этот раздел в указанную записную книжку. |
copy |
Копирует этот раздел в указанную группу разделов. |
get |
Возвращает идентификатор REST API. |
insert |
Вставляет новый раздел перед текущим разделом или после него. |
insert |
Вставляет новый раздел перед текущим разделом или после него. |
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
toJSON() | Переопределяет метод JavaScript |
track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для |
untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для |
Сведения о свойстве
clientUrl
URL-адрес клиента раздела. Только чтение
readonly clientUrl: string;
Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
id
Получает идентификатор объекта Section. Только для чтения.
readonly id: string;
Значение свойства
string
Комментарии
isEncrypted
Значение true, если этот раздел зашифрован с помощью пароля. Только чтение
readonly isEncrypted: boolean;
Значение свойства
boolean
Комментарии
isLocked
Значение true, если этот раздел заблокирован. Только чтение
readonly isLocked: boolean;
Значение свойства
boolean
Комментарии
name
Получает имя раздела. Только для чтения.
readonly name: string;
Значение свойства
string
Комментарии
notebook
Получает записную книжку, содержащую раздел. Только для чтения.
readonly notebook: OneNote.Notebook;
Значение свойства
Комментарии
pages
Получает коллекцию страниц в разделе. Только чтение
readonly pages: OneNote.PageCollection;
Значение свойства
Комментарии
parentSectionGroup
Получает группу объектов, содержащую раздел. Возвращает значение ItemNotFound, если раздел является прямым потомком записной книжки. Только для чтения.
readonly parentSectionGroup: OneNote.SectionGroup;
Значение свойства
Комментарии
parentSectionGroupOrNull
Получает группу объектов, содержащую раздел. Возвращает значение null, если объект Section является прямым потомком объекта Notebook. Только для чтения.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;
Значение свойства
Комментарии
webUrl
URL-адрес страницы. Только чтение
readonly webUrl: string;
Значение свойства
string
Комментарии
Сведения о методе
addPage(title)
Добавляет новую страницу в конец раздела.
addPage(title: string): OneNote.Page;
Параметры
- title
-
string
Название новой страницы.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Queue a command to add a page to the current section.
const page = context.application.getActiveSection().addPage("Wish list");
// Queue a command to load the id and title of the new page.
// This example loads the new page so it can read its properties later.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Page name: " + page.title);
console.log("Page ID: " + page.id);
});
copyToNotebook(destinationNotebook)
Копирует этот раздел в указанную записную книжку.
copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;
Параметры
- destinationNotebook
- OneNote.Notebook
Записная книжка, куда нужно скопировать этот раздел.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
const app = context.application;
// Gets the active Notebook.
const notebook = app.getActiveNotebook();
// Gets the active Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
newSection = section.copyToNotebook(notebook);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
copyToSectionGroup(destinationSectionGroup)
Копирует этот раздел в указанную группу разделов.
copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;
Параметры
- destinationSectionGroup
- OneNote.SectionGroup
Группа разделов, куда нужно скопировать этот раздел.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
const app = context.application;
// Gets the active Notebook.
const notebook = app.getActiveNotebook();
// Gets the active Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
const firstSectionGroup = notebook.sectionGroups.items[0];
newSection = section.copyToSectionGroup(firstSectionGroup);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
getRestApiId()
Возвращает идентификатор REST API.
getRestApiId(): OfficeExtension.ClientResult<string>;
Возвращаемое значение
OfficeExtension.ClientResult<string>
Комментарии
Примеры
await OneNote.run(async (context) => {
// Get the current section.
const section = context.application.getActiveSection();
const restApiId = section.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
});
insertSectionAsSibling(location, title)
Вставляет новый раздел перед текущим разделом или после него.
insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;
Параметры
- location
- OneNote.InsertLocation
Расположение нового раздела относительно текущего раздела.
- title
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
insertSectionAsSibling(locationString, title)
Вставляет новый раздел перед текущим разделом или после него.
insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;
Параметры
- locationString
-
"Before" | "After"
Расположение нового раздела относительно текущего раздела.
- title
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Queue a command to insert a section after the current section.
const section = context.application.getActiveSection().insertSectionAsSibling("After", "New section");
// Queue a command to load the id and name of the new section.
// This example loads the new section so it can read its properties later.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: OneNote.Interfaces.SectionLoadOptions): OneNote.Section;
Параметры
Предоставляет параметры свойств загружаемого объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): OneNote.Section;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
await OneNote.run(async (context) => {
// Get the current section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Section ID: " + section.id);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Section;
Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный объект OneNote.Section является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.SectionData
), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): OneNote.Interfaces.SectionData;
Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject)
. Если вы используете этот объект в вызовах .sync
и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
track(): OneNote.Section;
Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject)
. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync()
до того, как выпуск памяти вступит в силу.
untrack(): OneNote.Section;
Возвращаемое значение
Office Add-ins