OneNote.SectionGroup class

Ссылка

Пакет:: onenote

Представляет группу разделов OneNote. Объекты SectionGroup могут содержать объекты Section и другие объекты SectionGroup.

Extends: OfficeExtension.ClientObject

Свойства

clientUrl	URL-адрес клиента группы разделов. Только чтение
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор объекта SectionGroup. Только для чтения.
name	Имя группы разделов. Только для чтения.
notebook	Получает записную книжку, содержащую группу разделов. Только для чтения.
parentSectionGroup	Получает группу разделов, содержащую другую группу разделов. Возвращает значение ItemNotFound, если групп разделов является прямым потомком записной книжки. Только для чтения.
parentSectionGroupOrNull	Получает группу разделов, содержащую другую группу разделов. Возвращает значение null, если объект SectionGroup является прямым потомком объекта Notebook. Только для чтения.
sectionGroups	Коллекция групп разделов в группе разделов. Только чтение
sections	Коллекция разделов в группе разделов. Только чтение

Методы

addSection(title)	Добавляет новый раздел в конец группы разделов.
addSectionGroup(name)	Добавляет новую группу разделов в конец sectionGroup.
getRestApiId()	Возвращает идентификатор REST API.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект OneNote.SectionGroup является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.SectionGroupData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для `context.trackedObjects.add(thisObject)`. Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для `context.trackedObjects.remove(thisObject)`. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

Сведения о свойстве

clientUrl

URL-адрес клиента группы разделов. Только чтение

readonly clientUrl: string;

Значение свойства

string

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

OneNote.RequestContext

id

Получает идентификатор объекта SectionGroup. Только для чтения.

readonly id: string;

Значение свойства

string

name

Имя группы разделов. Только для чтения.

readonly name: string;

Значение свойства

string

notebook

Получает записную книжку, содержащую группу разделов. Только для чтения.

readonly notebook: OneNote.Notebook;

Значение свойства

OneNote.Notebook

parentSectionGroup

Получает группу разделов, содержащую другую группу разделов. Возвращает значение ItemNotFound, если групп разделов является прямым потомком записной книжки. Только для чтения.

readonly parentSectionGroup: OneNote.SectionGroup;

Значение свойства

OneNote.SectionGroup

parentSectionGroupOrNull

Получает группу разделов, содержащую другую группу разделов. Возвращает значение null, если объект SectionGroup является прямым потомком объекта Notebook. Только для чтения.

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Значение свойства

OneNote.SectionGroup

sectionGroups

Коллекция групп разделов в группе разделов. Только чтение

readonly sectionGroups: OneNote.SectionGroupCollection;

Значение свойства

OneNote.SectionGroupCollection

sections

Коллекция разделов в группе разделов. Только чтение

readonly sections: OneNote.SectionCollection;

Значение свойства

OneNote.SectionCollection

Сведения о методе

addSection(title)

Добавляет новый раздел в конец группы разделов.

addSection(title: string): OneNote.Section;

Параметры

title: string

Имя нового раздела.

Возвращаемое значение

OneNote.Section

Примеры

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

Имя нового раздела.

Возвращаемое значение

OneNote.SectionGroup

Примеры

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;

Параметры

options: OneNote.Interfaces.SectionGroupLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

OneNote.SectionGroup

load(propertyNames)

load(propertyNames?: string | string[]): OneNote.SectionGroup;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

OneNote.SectionGroup

Примеры

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)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.SectionGroup;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

OneNote.SectionGroup

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.SectionGroup является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.SectionGroupData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): OneNote.Interfaces.SectionGroupData;

Возвращаемое значение

OneNote.Interfaces.SectionGroupData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.SectionGroup;

Возвращаемое значение

OneNote.SectionGroup

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.SectionGroup;

Возвращаемое значение

OneNote.SectionGroup

Поделиться через

OneNote.SectionGroup class

Комментарии

Свойства

Методы

Сведения о свойстве

clientUrl

Значение свойства

Комментарии

context

Значение свойства

id

Значение свойства

Комментарии

name

Значение свойства

Комментарии

notebook

Значение свойства

Комментарии

parentSectionGroup

Значение свойства

Комментарии

parentSectionGroupOrNull

Значение свойства

Комментарии

sectionGroups

Значение свойства

Комментарии

sections

Значение свойства

Комментарии

Сведения о методе

addSection(title)

Параметры

Возвращаемое значение

Комментарии

Примеры

addSectionGroup(name)

Параметры

Возвращаемое значение

Комментарии

Примеры

getRestApiId()

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

Примеры

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

track()

Возвращаемое значение

untrack()

Возвращаемое значение

Обратная связь

Дополнительные ресурсы