onenote package
Классы
OneNote.Application |
Представляет собой объект верхнего уровня и содержит все глобально адресуемые объекты OneNote, например записные книжки, активную записную книжку и активный раздел. |
OneNote.FloatingInk |
Представляет группу росчерков пера. |
OneNote.Image |
Представляет изображение. Объект Image может быть прямым потомком объекта PageContent или объекта Paragraph. |
OneNote.InkAnalysis |
Представляет данные анализа рукописного фрагмента для заданного набора росчерков пера. |
OneNote.InkAnalysisLine |
Представляет данные анализа рукописного фрагмента для определенной текстовой строки, созданной росчерками пера. |
OneNote.InkAnalysisLineCollection |
Представляет коллекцию объектов InkAnalysisLine. |
OneNote.InkAnalysisParagraph |
Представляет данные анализа рукописного фрагмента для определенного абзаца, образованного росчерками пера. |
OneNote.InkAnalysisParagraphCollection |
Представляет коллекцию объектов InkAnalysisParagraph. |
OneNote.InkAnalysisWord |
Представляет данные анализа рукописного фрагмента для определенного слова, созданного росчерками пера. |
OneNote.InkAnalysisWordCollection |
Представляет коллекцию объектов InkAnalysisWord. |
OneNote.InkStroke |
Представляет один росчерк пера. |
OneNote.InkStrokeCollection |
Представляет коллекцию объектов InkStroke. |
OneNote.InkWord |
Контейнер для рукописного фрагмента в слове абзаца. |
OneNote.InkWordCollection |
Представляет коллекцию объектов InkWord. |
OneNote.Notebook |
Представляет записную книжку OneNote. Записные книжки содержат группы разделов и разделы. |
OneNote.NotebookCollection |
Представляет коллекцию записных книжек. |
OneNote.NoteTag |
Контейнер для NoteTag в абзаце. |
OneNote.Outline |
Представляет контейнер для объектов Paragraph. |
OneNote.Page |
Представляет страницу OneNote. |
OneNote.PageCollection |
Представляет коллекцию страниц. |
OneNote.PageContent |
Представляет область на странице, содержащую контент верхнего уровня, например Outline или Image. Объекту PageContent можно назначить позицию по горизонтали и вертикали. |
OneNote.PageContentCollection |
Представляет содержимое страницы в виде коллекции объектов PageContent. |
OneNote.Paragraph |
Контейнер для контента, отображаемого на странице. Объект Paragraph может содержать контент с любым типом ParagraphType. |
OneNote.ParagraphCollection |
Представляет коллекцию объектов Paragraph. |
OneNote.Point |
Представляет одну точку рукописного росчерка |
OneNote.PointCollection |
Представляет коллекцию объектов Point. |
OneNote.RequestContext | |
OneNote.RichText |
Представляет объект RichText в объекте Paragraph. |
OneNote.Section |
Представляет раздел в OneNote. Разделы могут содержать страницы. |
OneNote.SectionCollection |
Представляет коллекцию разделов. |
OneNote.SectionGroup |
Представляет группу разделов OneNote. Объекты SectionGroup могут содержать объекты Section и другие объекты SectionGroup. |
OneNote.SectionGroupCollection |
Представляет коллекцию групп разделов. |
OneNote.Table |
Представляет таблицу на странице OneNote. |
OneNote.TableCell |
Представляет ячейку в таблице OneNote. |
OneNote.TableCellCollection |
Содержит коллекцию объектов TableCell. |
OneNote.TableRow |
Представляет строку в таблице. |
OneNote.TableRowCollection |
Содержит коллекцию объектов TableRow. |
Интерфейсы
OneNote.ImageOcrData |
Представляет данные, полученные с помощью OCR (оптического распознавания символов) изображения. |
OneNote.InkStrokePointer |
Слабая ссылка на объект росчерка рукописного ввода и его родительский элемент содержимого. |
OneNote.Interfaces.ApplicationData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.ApplicationLoadOptions |
Представляет собой объект верхнего уровня и содержит все глобально адресуемые объекты OneNote, например записные книжки, активную записную книжку и активный раздел. |
OneNote.Interfaces.ApplicationUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.CollectionLoadOptions |
Предоставляет способы загрузки свойств только подмножества элементов коллекции. |
OneNote.Interfaces.FloatingInkData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.FloatingInkLoadOptions |
Представляет группу росчерков пера. |
OneNote.Interfaces.ImageData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.ImageLoadOptions |
Представляет изображение. Объект Image может быть прямым потомком объекта PageContent или объекта Paragraph. |
OneNote.Interfaces.ImageUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisLineCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions |
Представляет коллекцию объектов InkAnalysisLine. |
OneNote.Interfaces.InkAnalysisLineCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisLineData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisLineLoadOptions |
Представляет данные анализа рукописного фрагмента для определенной текстовой строки, созданной росчерками пера. |
OneNote.Interfaces.InkAnalysisLineUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisLoadOptions |
Представляет данные анализа рукописного фрагмента для заданного набора росчерков пера. |
OneNote.Interfaces.InkAnalysisParagraphCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions |
Представляет коллекцию объектов InkAnalysisParagraph. |
OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisParagraphData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisParagraphLoadOptions |
Представляет данные анализа рукописного фрагмента для определенного абзаца, образованного росчерками пера. |
OneNote.Interfaces.InkAnalysisParagraphUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisWordCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions |
Представляет коллекцию объектов InkAnalysisWord. |
OneNote.Interfaces.InkAnalysisWordCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkAnalysisWordData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkAnalysisWordLoadOptions |
Представляет данные анализа рукописного фрагмента для определенного слова, созданного росчерками пера. |
OneNote.Interfaces.InkAnalysisWordUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkStrokeCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkStrokeCollectionLoadOptions |
Представляет коллекцию объектов InkStroke. |
OneNote.Interfaces.InkStrokeCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkStrokeData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkStrokeLoadOptions |
Представляет один росчерк пера. |
OneNote.Interfaces.InkWordCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkWordCollectionLoadOptions |
Представляет коллекцию объектов InkWord. |
OneNote.Interfaces.InkWordCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.InkWordData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.InkWordLoadOptions |
Контейнер для рукописного фрагмента в слове абзаца. |
OneNote.Interfaces.NotebookCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.NotebookCollectionLoadOptions |
Представляет коллекцию записных книжек. |
OneNote.Interfaces.NotebookCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.NotebookData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.NotebookLoadOptions |
Представляет записную книжку OneNote. Записные книжки содержат группы разделов и разделы. |
OneNote.Interfaces.NoteTagData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.NoteTagLoadOptions |
Контейнер для NoteTag в абзаце. |
OneNote.Interfaces.OutlineData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.OutlineLoadOptions |
Представляет контейнер для объектов Paragraph. |
OneNote.Interfaces.PageCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PageCollectionLoadOptions |
Представляет коллекцию страниц. |
OneNote.Interfaces.PageCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.PageContentCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PageContentCollectionLoadOptions |
Представляет содержимое страницы в виде коллекции объектов PageContent. |
OneNote.Interfaces.PageContentCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.PageContentData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PageContentLoadOptions |
Представляет область на странице, содержащую контент верхнего уровня, например Outline или Image. Объекту PageContent можно назначить позицию по горизонтали и вертикали. |
OneNote.Interfaces.PageContentUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.PageData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PageLoadOptions |
Представляет страницу OneNote. |
OneNote.Interfaces.PageUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.ParagraphCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.ParagraphCollectionLoadOptions |
Представляет коллекцию объектов Paragraph. |
OneNote.Interfaces.ParagraphCollectionUpdateData |
Интерфейс для обновления данных объекта ParagraphCollection для использования в |
OneNote.Interfaces.ParagraphData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.ParagraphLoadOptions |
Контейнер для контента, отображаемого на странице. Объект Paragraph может содержать контент с любым типом ParagraphType. |
OneNote.Interfaces.ParagraphUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.PointCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PointCollectionLoadOptions |
Представляет коллекцию объектов Point. |
OneNote.Interfaces.PointCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.PointData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.PointLoadOptions |
Представляет одну точку рукописного росчерка |
OneNote.Interfaces.RichTextData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.RichTextLoadOptions |
Представляет объект RichText в объекте Paragraph. |
OneNote.Interfaces.SectionCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.SectionCollectionLoadOptions |
Представляет коллекцию разделов. |
OneNote.Interfaces.SectionCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.SectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.SectionGroupCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.SectionGroupCollectionLoadOptions |
Представляет коллекцию групп разделов. |
OneNote.Interfaces.SectionGroupCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.SectionGroupData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.SectionGroupLoadOptions |
Представляет группу разделов OneNote. Объекты SectionGroup могут содержать объекты Section и другие объекты SectionGroup. |
OneNote.Interfaces.SectionLoadOptions |
Представляет раздел в OneNote. Разделы могут содержать страницы. |
OneNote.Interfaces.TableCellCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.TableCellCollectionLoadOptions |
Содержит коллекцию объектов TableCell. |
OneNote.Interfaces.TableCellCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.TableCellData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.TableCellLoadOptions |
Представляет ячейку в таблице OneNote. |
OneNote.Interfaces.TableCellUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.TableData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.TableLoadOptions |
Представляет таблицу на странице OneNote. |
OneNote.Interfaces.TableRowCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.TableRowCollectionLoadOptions |
Содержит коллекцию объектов TableRow. |
OneNote.Interfaces.TableRowCollectionUpdateData |
Интерфейс для обновления данных объекта |
OneNote.Interfaces.TableRowData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
OneNote.Interfaces.TableRowLoadOptions |
Представляет строку в таблице. |
OneNote.Interfaces.TableUpdateData |
Интерфейс для обновления данных объекта |
OneNote.ParagraphInfo |
Вывод сведений для абзаца. |
Перечисления
Функции
One |
Выполняет пакетный скрипт, который выполняет действия в объектной модели OneNote, используя новый контекст запроса. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены. |
One |
Выполняет пакетный скрипт, выполняющий действия в объектной модели OneNote, используя контекст запроса ранее созданного объекта API. |
One |
Выполняет пакетный скрипт, который выполняет действия в объектной модели OneNote, используя контекст запроса ранее созданных объектов API. |
Сведения о функции
OneNote.run(batch)
Выполняет пакетный скрипт, который выполняет действия в объектной модели OneNote, используя новый контекст запроса. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
export function run<T>(batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;
Параметры
- batch
-
(context: OneNote.RequestContext) => Promise<T>
Функция, которая принимает oneNote.RequestContext и возвращает обещание (как правило, только результат "context.sync()"). Параметр контекста упрощает запросы к приложению OneNote. Так как надстройка Office и приложение OneNote выполняются в двух разных процессах, контекст запроса необходим для получения доступа к объектной модели OneNote из надстройки.
Возвращаемое значение
Promise<T>
OneNote.run(object, batch)
Выполняет пакетный скрипт, выполняющий действия в объектной модели OneNote, используя контекст запроса ранее созданного объекта API.
export function run<T>(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;
Параметры
- object
- OfficeExtension.ClientObject
Ранее созданный объект API. Пакет будет использовать тот же контекст запроса, что и переданный объект. Это означает, что любые изменения, примененные к объекту, будут приняты командой context.sync().
- batch
-
(context: OneNote.RequestContext) => Promise<T>
Функция, которая принимает oneNote.RequestContext и возвращает обещание (как правило, только результат "context.sync()"). При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
Возвращаемое значение
Promise<T>
OneNote.run(objects, batch)
Выполняет пакетный скрипт, который выполняет действия в объектной модели OneNote, используя контекст запроса ранее созданных объектов API.
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;
Параметры
- objects
- batch
-
(context: OneNote.RequestContext) => Promise<T>
Функция, которая принимает oneNote.RequestContext и возвращает обещание (как правило, только результат "context.sync()"). При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
Возвращаемое значение
Promise<T>
Office Add-ins