OneNote.Notebook class

Пакет:

onenote

Представляет записную книжку OneNote. Записные книжки содержат группы разделов и разделы.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: OneNoteApi 1.1

Используется

• OneNote.Application: getActiveNotebook, getActiveNotebookOrNull
• OneNote.NotebookCollection: getItem, getItemAt, items
• OneNote.Section: copyToNotebook, записная книжка
• OneNote.SectionGroup: записная книжка

Свойства

baseUrl	URL-адрес сайта, на котором находится записная книжка. Только для чтения.
clientUrl	URL-адрес записной книжки для клиента. Только для чтения.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
id	Получает идентификатор записной книжки. Только для чтения.
isVirtual	Возвращает значение "True", если записная книжка создана не пользователем (например, "Перемещенные разделы").
name	Получает имя записной книжки.
sectionGroups	Группы разделов в записной книжке.
sections	Разделы записной книжки.

Методы

addSection(name)	Добавляет новый раздел в конец записной книжки.
addSectionGroup(name)	Добавляет новую группу разделов в конец записной книжки.
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.Notebook объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как OneNote.Interfaces.NotebookData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

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

baseUrl

URL-адрес сайта, на котором находится записная книжка. Только для чтения.

readonly baseUrl: string;

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

string

Комментарии

Набор API: OneNoteApi 1.1

clientUrl

URL-адрес записной книжки для клиента. Только для чтения.

readonly clientUrl: string;

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

string

Комментарии

Набор API: OneNoteApi 1.1

context

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

context: RequestContext;

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

OneNote.RequestContext

id

Получает идентификатор записной книжки. Только для чтения.

readonly id: string;

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

string

Комментарии

Набор API: OneNoteApi 1.1

isVirtual

Возвращает значение "True", если записная книжка создана не пользователем (например, "Перемещенные разделы").

readonly isVirtual: boolean;

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

boolean

Комментарии

Набор API: OneNoteApi 1.2

name

Получает имя записной книжки.

readonly name: string;

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

string

Комментарии

Набор API: OneNoteApi 1.1

sectionGroups

Группы разделов в записной книжке.

readonly sectionGroups: OneNote.SectionGroupCollection;

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

OneNote.SectionGroupCollection

Комментарии

Набор API: OneNoteApi 1.1

sections

Разделы записной книжки.

readonly sections: OneNote.SectionCollection;

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

OneNote.SectionCollection

Комментарии

Набор API: OneNoteApi 1.1

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

addSection(name)

Добавляет новый раздел в конец записной книжки.

addSection(name: string): OneNote.Section;

Параметры

name

string

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

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

OneNote.Section

Комментарии

Набор API: OneNoteApi 1.1

Примеры

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

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

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

OneNote.SectionGroup

Комментарии

Набор API: OneNoteApi 1.1

Примеры

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>

Комментарии

Набор API: OneNoteApi 1.1

Примеры

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;

Параметры

options

OneNote.Interfaces.NotebookLoadOptions

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

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

OneNote.Notebook

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

OneNote.Notebook

Примеры

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 через запятую, указывающая свойства навигации для загрузки.

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

OneNote.Notebook

toJSON()

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

toJSON(): OneNote.Interfaces.NotebookData;

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

OneNote.Interfaces.NotebookData

track()

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

track(): OneNote.Notebook;

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

OneNote.Notebook

untrack()

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

untrack(): OneNote.Notebook;

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

OneNote.Notebook