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

OneNote.PageContent class

  • Ссылка
Пакет:
onenote

Представляет область на странице, содержащую контент верхнего уровня, например Outline или Image. Объекту PageContent можно назначить позицию по горизонтали и вертикали.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

context

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

Возвращает идентификатор объекта PageContent.
image

Получает объект Image в объекте PageContent. Вызывает исключение, если PageContentType не является Image.
ink

Получает рукописный фрагмент в объекте PageContent. Вызывает исключение, если PageContentType не является Ink.
left

Получает или задает левую позицию (по оси X) объекта PageContent.
outline

Получает элемент типа Outline в объекте PageContent. Вызывает исключение, если PageContentType не является Outline.
parentPage

Получает страницу, содержащую объект PageContent.
top

Получает или задает верхнюю позицию (по оси Y) объекта PageContent.
type

Получает тип объекта PageContent.

Методы

delete()

Удаляет объект PageContent.
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.PageContent объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.PageContentData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

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

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

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

context

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

context: RequestContext;

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

OneNote.RequestContext

id

Возвращает идентификатор объекта PageContent.

readonly id: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

image

Получает объект Image в объекте PageContent. Вызывает исключение, если PageContentType не является Image.

readonly image: OneNote.Image;

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

OneNote.Image

Комментарии

[ Набор API: OneNoteApi 1.1 ]

ink

Получает рукописный фрагмент в объекте PageContent. Вызывает исключение, если PageContentType не является Ink.

readonly ink: OneNote.FloatingInk;

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

OneNote.FloatingInk

Комментарии

[ Набор API: OneNoteApi 1.1 ]

left

Получает или задает левую позицию (по оси X) объекта PageContent.

left: number;

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

number

Комментарии

[ Набор API: OneNoteApi 1.1 ]

outline

Получает элемент типа Outline в объекте PageContent. Вызывает исключение, если PageContentType не является Outline.

readonly outline: OneNote.Outline;

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

OneNote.Outline

Комментарии

[ Набор API: OneNoteApi 1.1 ]

parentPage

Получает страницу, содержащую объект PageContent.

readonly parentPage: OneNote.Page;

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

OneNote.Page

Комментарии

[ Набор API: OneNoteApi 1.1 ]

top

Получает или задает верхнюю позицию (по оси Y) объекта PageContent.

top: number;

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

number

Комментарии

[ Набор API: OneNoteApi 1.1 ]

type

Получает тип объекта PageContent.

readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

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

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

delete()

Удаляет объект PageContent.

delete(): void;

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

void

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

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

    const page = context.application.getActivePage();
    const pageContents = page.contents;

    const firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (firstPageContent.isNullObject === false) {
        firstPageContent.delete();
        await context.sync();
    }
});

load(options)

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

load(options?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;

Параметры

options
OneNote.Interfaces.PageContentLoadOptions

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

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

OneNote.PageContent

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

OneNote.PageContent

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

OneNote.PageContent

set(properties, options)

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

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

Параметры

properties
OneNote.Interfaces.PageContentUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: OneNote.PageContent): void;

Параметры

properties
OneNote.PageContent

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

void

toJSON()

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

toJSON(): OneNote.Interfaces.PageContentData;

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

OneNote.Interfaces.PageContentData

track()

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

track(): OneNote.PageContent;

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

OneNote.PageContent

untrack()

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

untrack(): OneNote.PageContent;

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

OneNote.PageContent