OneNote.SectionGroup class

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

readonly clientUrl: string;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

context: RequestContext;

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

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

readonly id: string;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Имя группы разделов.

readonly name: string;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

readonly notebook: OneNote.Notebook;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

readonly parentSectionGroup: OneNote.SectionGroup;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Коллекция групп разделов в группе разделов.

readonly sectionGroups: OneNote.SectionGroupCollection;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Коллекция разделов в группе разделов.

readonly sections: OneNote.SectionCollection;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

addSection(title: string): OneNote.Section;

Параметры

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

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();
});

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

addSectionGroup(name: string): OneNote.SectionGroup;

Параметры

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

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);
});

Возвращает идентификатор REST API.

getRestApiId(): OfficeExtension.ClientResult<string>;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.SectionGroupLoadOptions): OneNote.SectionGroup;

Параметры

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

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(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);
});

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

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

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

toJSON(): OneNote.Interfaces.SectionGroupData;

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

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

track(): OneNote.SectionGroup;

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

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

untrack(): OneNote.SectionGroup;

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