OneNote.PageContent class
Представляет область на странице, содержащую контент верхнего уровня, например Outline или Image. Объекту PageContent можно назначить позицию по горизонтали и вертикали.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Возвращает идентификатор объекта PageContent. |
| image | Получает объект Image в объекте PageContent. Вызывает исключение, если PageContentType не является Image. |
| ink | Получает рукописный фрагмент в объекте PageContent. Вызывает исключение, если PageContentType не является Ink. |
| left | Получает или задает левую позицию (по оси X) объекта PageContent. |
| outline | Получает элемент типа Outline в объекте PageContent. Вызывает исключение, если PageContentType не является Outline. |
| parent |
Получает страницу, содержащую объект PageContent. |
| top | Получает или задает верхнюю позицию (по оси Y) объекта PageContent. |
| type | Получает тип объекта PageContent. |
Методы
| delete() | Удаляет объект PageContent. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Возвращает идентификатор объекта PageContent.
readonly id: string;Значение свойства
string
Комментарии
image
Получает объект Image в объекте PageContent. Вызывает исключение, если PageContentType не является Image.
readonly image: OneNote.Image;Значение свойства
Комментарии
ink
Получает рукописный фрагмент в объекте PageContent. Вызывает исключение, если PageContentType не является Ink.
readonly ink: OneNote.FloatingInk;Значение свойства
Комментарии
left
Получает или задает левую позицию (по оси X) объекта PageContent.
left: number;Значение свойства
number
Комментарии
outline
Получает элемент типа Outline в объекте PageContent. Вызывает исключение, если PageContentType не является Outline.
readonly outline: OneNote.Outline;Значение свойства
Комментарии
parentPage
Получает страницу, содержащую объект PageContent.
readonly parentPage: OneNote.Page;Значение свойства
Комментарии
top
Получает или задает верхнюю позицию (по оси Y) объекта PageContent.
top: number;Значение свойства
number
Комментарии
type
Получает тип объекта PageContent.
readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";Значение свойства
OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"
Комментарии
Сведения о методе
delete()
Удаляет объект PageContent.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
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;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): OneNote.PageContent;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.PageContent;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.PageContentUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- OneNote.Interfaces.PageContentUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.
track(): OneNote.PageContent;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): OneNote.PageContent;