OneNote.SectionGroup class
Представляет группу разделов OneNote. Объекты SectionGroup могут содержать объекты Section и другие объекты SectionGroup.
- Extends
Комментарии
Используется
Свойства
| client |
URL-адрес клиента группы разделов. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Получает идентификатор объекта SectionGroup. |
| name | Имя группы разделов. |
| notebook | Получает записную книжку, содержащую группу разделов. |
| parent |
Получает группу разделов, содержащую другую группу разделов. Возвращает значение ItemNotFound, если групп разделов является прямым потомком записной книжки. |
| parent |
Получает группу разделов, содержащую другую группу разделов. Возвращает значение null, если объект SectionGroup является прямым потомком объекта Notebook. |
| section |
Коллекция групп разделов в группе разделов. |
| sections | Коллекция разделов в группе разделов. |
Методы
| add |
Добавляет новый раздел в конец группы разделов. |
| add |
Добавляет новую группу разделов в конец sectionGroup. |
| get |
Получает идентификатор REST API. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
clientUrl
URL-адрес клиента группы разделов.
readonly clientUrl: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Получает идентификатор объекта SectionGroup.
readonly id: string;Значение свойства
string
Комментарии
name
Имя группы разделов.
readonly name: string;Значение свойства
string
Комментарии
notebook
Получает записную книжку, содержащую группу разделов.
readonly notebook: OneNote.Notebook;Значение свойства
Комментарии
parentSectionGroup
Получает группу разделов, содержащую другую группу разделов. Возвращает значение ItemNotFound, если групп разделов является прямым потомком записной книжки.
readonly parentSectionGroup: OneNote.SectionGroup;Значение свойства
Комментарии
parentSectionGroupOrNull
Получает группу разделов, содержащую другую группу разделов. Возвращает значение null, если объект SectionGroup является прямым потомком объекта Notebook.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;Значение свойства
Комментарии
sectionGroups
Коллекция групп разделов в группе разделов.
readonly sectionGroups: OneNote.SectionGroupCollection;Значение свойства
Комментарии
sections
Коллекция разделов в группе разделов.
readonly sections: OneNote.SectionCollection;Значение свойства
Комментарии
Сведения о методе
addSection(title)
Добавляет новый раздел в конец группы разделов.
addSection(title: string): OneNote.Section;Параметры
- title
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Add a section to each section group.
$.each(sectionGroups.items, function(index, sectionGroup) {
sectionGroup.addSection("Agenda");
});
// Run the queued commands.
await context.sync();
});
addSectionGroup(name)
Добавляет новую группу разделов в конец sectionGroup.
addSectionGroup(name: string): OneNote.SectionGroup;Параметры
- name
-
string
Имя нового раздела.
Возвращаемое значение
Комментарии
Примеры
await OneNote.run(async (context) => {
let sectionGroup;
let nestedSectionGroup;
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section group.
const sectionGroups = notebook.sectionGroups;
// Queue a command to load the new section group.
sectionGroups.load();
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
sectionGroup = sectionGroups.items[0];
sectionGroup.load();
await context.sync();
nestedSectionGroup = sectionGroup.addSectionGroup("Sample nested section group");
nestedSectionGroup.load();
await context.sync();
console.log("New nested section group name is " + nestedSectionGroup.name);
});
getRestApiId()
Получает идентификатор REST API.
getRestApiId(): OfficeExtension.ClientResult<string>;Возвращаемое значение
OfficeExtension.ClientResult<string>
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: OneNote.Interfaces.SectionGroupLoadOptions): OneNote.SectionGroup;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): OneNote.SectionGroup;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
await OneNote.run(async (context) => {
// Get the parent section group that contains the current section.
const sectionGroup = context.application.getActiveSection().parentSectionGroup;
// Queue a command to load the section group.
// For best performance, request specific properties.
sectionGroup.load("id,name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Write the properties.
console.log("Section group name: " + sectionGroup.name);
console.log("Section group ID: " + sectionGroup.id);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.SectionGroup;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.SectionGroup объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как OneNote.Interfaces.SectionGroupData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): OneNote.Interfaces.SectionGroupData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.
track(): OneNote.SectionGroup;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): OneNote.SectionGroup;