OneNote.Page class

Ссылка

Пакет:: onenote

Представляет страницу OneNote.

Extends: OfficeExtension.ClientObject

Свойства

classNotebookPageSource	Возвращает classNotebookPageSource на страницу.
clientUrl	URL-адрес клиента страницы. Только чтение
contents	Коллекция объектов PageContent на странице. Только чтение
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор страницы. Только для чтения.
inkAnalysisOrNull	Интерпретация текста для рукописного ввода на странице. Возвращает значение null, если отсутствуют данные анализа рукописного фрагмента.
pageLevel	Получает или задает уровень отступа для страницы.
parentSection	Получает раздел, содержащий страницу. Только для чтения.
title	Получает или задает название страницы.
webUrl	URL-адрес страницы. Только чтение

Методы

addOutline(left, top, html)	Добавляет объект Outline на страницу в заданной позиции.
analyzePage()	Возвращает строку JSON с идентификатором узла и содержимым в формате HTML.
applyTranslation(translatedContent)	Вставляет новую страницу с переведенным содержимым.
copyToSection(destinationSection)	Копирует эту страницу в указанный раздел.
copyToSectionAndSetClassNotebookPageSource(destinationSection)	Копирует эту страницу в указанный раздел и задает classNotebookPageSource.
getRestApiId()	Возвращает идентификатор REST API.
hasTitleContent()	Страница имеет заголовок содержимого.
insertPageAsSibling(location, title)	Вставляет новую страницу перед текущей страницей или после нее.
insertPageAsSibling(locationString, title)	Вставляет новую страницу перед текущей страницей или после нее.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект OneNote.Page является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.PageData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для `context.trackedObjects.add(thisObject)`. Если этот объект используется в `.sync` вызовах и вне последовательного выполнения пакета .run, и при установке свойства или вызове метода для объекта возникает ошибка InvalidObjectPath, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для `context.trackedObjects.remove(thisObject)`. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

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

classNotebookPageSource

Возвращает classNotebookPageSource на страницу.

readonly classNotebookPageSource: string;

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

string

clientUrl

URL-адрес клиента страницы. Только чтение

readonly clientUrl: string;

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

string

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

OneNote.PageContentCollection

context

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

context: RequestContext;

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

OneNote.RequestContext

id

Получает идентификатор страницы. Только для чтения.

readonly id: string;

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

string

inkAnalysisOrNull

Интерпретация текста для рукописного ввода на странице. Возвращает значение null, если отсутствуют данные анализа рукописного фрагмента.

readonly inkAnalysisOrNull: OneNote.InkAnalysis;

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

OneNote.InkAnalysis

pageLevel

Получает или задает уровень отступа для страницы.

pageLevel: number;

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

number

parentSection

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

readonly parentSection: OneNote.Section;

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

OneNote.Section

title

Получает или задает название страницы.

title: string;

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

string

webUrl

URL-адрес страницы. Только чтение

readonly webUrl: string;

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

string

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

addOutline(left, top, html)

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

addOutline(left: number, top: number, html: string): OneNote.Outline;

Параметры

left: number

Левая позиция верхней части, левый угол объекта Outline.

top: number

Верхняя позиция верхней части, левый угол объекта Outline.

html: string

Строка HTML, описывающая визуальное представление объекта Outline. См. раздел Поддерживаемый HTML для API JavaScript надстроек OneNote.

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

OneNote.Outline

Примеры

await OneNote.run(async (context) => {

    // Gets the active page.
    const page = context.application.getActivePage();

    // Queue a command to add an outline with given html.
    const outline = page.addOutline(200, 200,
"<p>Images and a table below:</p> \
 <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"> \
 <img src=\"http://imagenes.es.sftcdn.net/es/scrn/6653000/6653659/microsoft-onenote-2013-01-535x535.png\"> \
 <table> \
   <tr> \
     <td>Jill</td> \
     <td>Smith</td> \
     <td>50</td> \
   </tr> \
   <tr> \
     <td>Eve</td> \
     <td>Jackson</td> \
     <td>94</td> \
   </tr> \
 </table>"     
        );

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
});

analyzePage()

Возвращает строку JSON с идентификатором узла и содержимым в формате HTML.

analyzePage(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

applyTranslation(translatedContent)

Вставляет новую страницу с переведенным содержимым.

applyTranslation(translatedContent: string): void;

Параметры

translatedContent: string

Переведенное содержимое страницы

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

void

copyToSection(destinationSection)

Копирует эту страницу в указанный раздел.

copyToSection(destinationSection: OneNote.Section): OneNote.Page;

Параметры

destinationSection: OneNote.Section

Раздел, куда нужно скопировать эту страницу.

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

OneNote.Page

Примеры

await OneNote.run(async (context) => {
    const app = context.application;
    
    // Gets the active notebook.
    const notebook = app.getActiveNotebook();
    
    // Gets the active page.
    const page = app.getActivePage();
    
    // Queue a command to load sections under the notebook.
    notebook.load('sections');
    
    let newPage;
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const section = notebook.sections.items[0];
    
    // Copy page to the section.
    newPage = page.copyToSection(section);
    newPage.load('id');
    await context.sync();
    
    console.log(newPage.id);
});

copyToSectionAndSetClassNotebookPageSource(destinationSection)

Копирует эту страницу в указанный раздел и задает classNotebookPageSource.

copyToSectionAndSetClassNotebookPageSource(destinationSection: OneNote.Section): OneNote.Page;

Параметры

destinationSection: OneNote.Section

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

OneNote.Page

getRestApiId()

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

getRestApiId(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

await OneNote.run(async (context) => {
    // Get the current page.
    const page = context.application.getActivePage();
    const restApiId = page.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
});

hasTitleContent()

Страница имеет заголовок содержимого.

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

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

OfficeExtension.ClientResult<boolean>

insertPageAsSibling(location, title)

Вставляет новую страницу перед текущей страницей или после нее.

insertPageAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Page;

Параметры

location: OneNote.InsertLocation

Расположение новой страницы относительно текущей страницы.

title: string

Название новой страницы.

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

OneNote.Page

insertPageAsSibling(locationString, title)

Вставляет новую страницу перед текущей страницей или после нее.

insertPageAsSibling(locationString: "Before" | "After", title: string): OneNote.Page;

Параметры

locationString: "Before" | "After"

Расположение новой страницы относительно текущей страницы.

title: string

Название новой страницы.

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

OneNote.Page

Примеры

await OneNote.run(async (context) => {

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const newPage = activePage.insertPageAsSibling("After", "Next Page");

    // Queue a command to load the newPage to access its data.
    context.load(newPage);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("page is created with title: " + newPage.title);
});

load(options)

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

load(options?: OneNote.Interfaces.PageLoadOptions): OneNote.Page;

Параметры

options: OneNote.Interfaces.PageLoadOptions

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

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

OneNote.Page

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

OneNote.Page

Примеры

await OneNote.run(async (context) => {

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
    for(let i=0; i < pageContents.items.length; i++) {
        const pageContent = pageContents.items[i];
        if (pageContent.type == "Outline") {
            console.log("Found an outline");
        } else if (pageContent.type == "Image") {
            console.log("Found an image");
        } else if (pageContent.type == "Other") {
            console.log("Found a type not supported yet.");
        }
    }
});

load(propertyNamesAndPaths)

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

Параметры

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

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

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

OneNote.Page

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: OneNote.Interfaces.PageUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: OneNote.Page): void;

Параметры

properties: OneNote.Page

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

void

toJSON()

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

toJSON(): OneNote.Interfaces.PageData;

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

OneNote.Interfaces.PageData

track()

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

track(): OneNote.Page;

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

OneNote.Page

untrack()

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

untrack(): OneNote.Page;

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

OneNote.Page

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

OneNote.Page class

Комментарии

Свойства

Методы

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

classNotebookPageSource

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

Комментарии

clientUrl

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

Комментарии

contents

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

Комментарии

context

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

id

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

Комментарии

inkAnalysisOrNull

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

Комментарии

pageLevel

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

Комментарии

parentSection

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

Комментарии

title

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

Комментарии

webUrl

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

Комментарии

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

addOutline(left, top, html)

Параметры

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

Комментарии

Примеры

analyzePage()

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

Комментарии

applyTranslation(translatedContent)

Параметры

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

Комментарии

copyToSection(destinationSection)

Параметры

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

Комментарии

Примеры

copyToSectionAndSetClassNotebookPageSource(destinationSection)

Параметры

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

Комментарии

getRestApiId()

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

Комментарии

Примеры

hasTitleContent()

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

Комментарии

insertPageAsSibling(location, title)

Параметры

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

Комментарии

insertPageAsSibling(locationString, title)

Параметры

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры