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	Представляет данные, полученные с помощью оптического распознавания символов изображения.
OneNote.InkStrokePointer	Слабая ссылка на объект росчерка пера и его родительское содержимое.
OneNote.Interfaces.ApplicationData	Интерфейс, описывающий данные, возвращаемые вызовом application.toJSON().
OneNote.Interfaces.ApplicationLoadOptions	Представляет собой объект верхнего уровня и содержит все глобально адресуемые объекты OneNote, например записные книжки, активную записную книжку и активный раздел.
OneNote.Interfaces.ApplicationUpdateData	Интерфейс обновления данных об объекте Application для использования в application.set({ ... }).
OneNote.Interfaces.CollectionLoadOptions	Предоставляет способы загрузки свойств только подмножества членов семейства.
OneNote.Interfaces.FloatingInkData	Интерфейс, описывающий данные, возвращаемые вызовом floatingInk.toJSON().
OneNote.Interfaces.FloatingInkLoadOptions	Представляет группу росчерков пера.
OneNote.Interfaces.ImageData	Интерфейс, описывающий данные, возвращаемые вызовом image.toJSON().
OneNote.Interfaces.ImageLoadOptions	Представляет изображение. Объект Image может быть прямым потомком объекта PageContent или объекта Paragraph.
OneNote.Interfaces.ImageUpdateData	Интерфейс обновления данных об объекте Image для использования в image.set({ ... }).
OneNote.Interfaces.InkAnalysisData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysis.toJSON().
OneNote.Interfaces.InkAnalysisLineCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisLineCollection.toJSON().
OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions	Представляет коллекцию объектов InkAnalysisLine.
OneNote.Interfaces.InkAnalysisLineCollectionUpdateData	Интерфейс обновления данных об объекте InkAnalysisLineCollection для использования в inkAnalysisLineCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisLineData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisLine.toJSON().
OneNote.Interfaces.InkAnalysisLineLoadOptions	Представляет данные анализа рукописного фрагмента для определенной текстовой строки, созданной росчерками пера.
OneNote.Interfaces.InkAnalysisLineUpdateData	Интерфейс обновления данных об объекте InkAnalysisLine для использования в inkAnalysisLine.set({ ... }).
OneNote.Interfaces.InkAnalysisLoadOptions	Представляет данные анализа рукописного фрагмента для заданного набора росчерков пера.
OneNote.Interfaces.InkAnalysisParagraphCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisParagraphCollection.toJSON().
OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions	Представляет коллекцию объектов InkAnalysisParagraph.
OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData	Интерфейс обновления данных об объекте InkAnalysisParagraphCollection для использования в inkAnalysisParagraphCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisParagraphData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisParagraph.toJSON().
OneNote.Interfaces.InkAnalysisParagraphLoadOptions	Представляет данные анализа рукописного фрагмента для определенного абзаца, образованного росчерками пера.
OneNote.Interfaces.InkAnalysisParagraphUpdateData	Интерфейс обновления данных об объекте InkAnalysisParagraph для использования в inkAnalysisParagraph.set({ ... }).
OneNote.Interfaces.InkAnalysisUpdateData	Интерфейс обновления данных об объекте InkAnalysis для использования в inkAnalysis.set({ ... }).
OneNote.Interfaces.InkAnalysisWordCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisWordCollection.toJSON().
OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions	Представляет коллекцию объектов InkAnalysisWord.
OneNote.Interfaces.InkAnalysisWordCollectionUpdateData	Интерфейс обновления данных об объекте InkAnalysisWordCollection для использования в inkAnalysisWordCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisWordData	Интерфейс, описывающий данные, возвращаемые вызовом inkAnalysisWord.toJSON().
OneNote.Interfaces.InkAnalysisWordLoadOptions	Представляет данные анализа рукописного фрагмента для определенного слова, созданного росчерками пера.
OneNote.Interfaces.InkAnalysisWordUpdateData	Интерфейс обновления данных об объекте InkAnalysisWord для использования в inkAnalysisWord.set({ ... }).
OneNote.Interfaces.InkStrokeCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом inkStrokeCollection.toJSON().
OneNote.Interfaces.InkStrokeCollectionLoadOptions	Представляет коллекцию объектов InkStroke.
OneNote.Interfaces.InkStrokeCollectionUpdateData	Интерфейс обновления данных об объекте InkStrokeCollection для использования в inkStrokeCollection.set({ ... }).
OneNote.Interfaces.InkStrokeData	Интерфейс, описывающий данные, возвращаемые вызовом inkStroke.toJSON().
OneNote.Interfaces.InkStrokeLoadOptions	Представляет один росчерк пера.
OneNote.Interfaces.InkWordCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом inkWordCollection.toJSON().
OneNote.Interfaces.InkWordCollectionLoadOptions	Представляет коллекцию объектов InkWord.
OneNote.Interfaces.InkWordCollectionUpdateData	Интерфейс обновления данных об объекте InkWordCollection для использования в inkWordCollection.set({ ... }).
OneNote.Interfaces.InkWordData	Интерфейс, описывающий данные, возвращаемые вызовом inkWord.toJSON().
OneNote.Interfaces.InkWordLoadOptions	Контейнер для рукописного фрагмента в слове абзаца.
OneNote.Interfaces.NotebookCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом notebookCollection.toJSON().
OneNote.Interfaces.NotebookCollectionLoadOptions	Представляет коллекцию записных книжек.
OneNote.Interfaces.NotebookCollectionUpdateData	Интерфейс обновления данных об объекте NotebookCollection для использования в notebookCollection.set({ ... }).
OneNote.Interfaces.NotebookData	Интерфейс, описывающий данные, возвращаемые вызовом notebook.toJSON().
OneNote.Interfaces.NotebookLoadOptions	Представляет записную книжку OneNote. Записные книжки содержат группы разделов и разделы.
OneNote.Interfaces.NoteTagData	Интерфейс, описывающий данные, возвращаемые вызовом noteTag.toJSON().
OneNote.Interfaces.NoteTagLoadOptions	Контейнер для NoteTag в абзаце.
OneNote.Interfaces.OutlineData	Интерфейс, описывающий данные, возвращаемые вызовом outline.toJSON().
OneNote.Interfaces.OutlineLoadOptions	Представляет контейнер для объектов Paragraph.
OneNote.Interfaces.PageCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом pageCollection.toJSON().
OneNote.Interfaces.PageCollectionLoadOptions	Представляет коллекцию страниц.
OneNote.Interfaces.PageCollectionUpdateData	Интерфейс обновления данных об объекте PageCollection для использования в pageCollection.set({ ... }).
OneNote.Interfaces.PageContentCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом pageContentCollection.toJSON().
OneNote.Interfaces.PageContentCollectionLoadOptions	Представляет содержимое страницы в виде коллекции объектов PageContent.
OneNote.Interfaces.PageContentCollectionUpdateData	Интерфейс обновления данных об объекте PageContentCollection для использования в pageContentCollection.set({ ... }).
OneNote.Interfaces.PageContentData	Интерфейс, описывающий данные, возвращаемые вызовом pageContent.toJSON().
OneNote.Interfaces.PageContentLoadOptions	Представляет область на странице, содержащую контент верхнего уровня, например Outline или Image. Объекту PageContent можно назначить позицию по горизонтали и вертикали.
OneNote.Interfaces.PageContentUpdateData	Интерфейс обновления данных об объекте PageContent для использования в pageContent.set({ ... }).
OneNote.Interfaces.PageData	Интерфейс, описывающий данные, возвращаемые вызовом page.toJSON().
OneNote.Interfaces.PageLoadOptions	Представляет страницу OneNote.
OneNote.Interfaces.PageUpdateData	Интерфейс обновления данных об объекте Page для использования в page.set({ ... }).
OneNote.Interfaces.ParagraphCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом paragraphCollection.toJSON().
OneNote.Interfaces.ParagraphCollectionLoadOptions	Представляет коллекцию объектов Paragraph.
OneNote.Interfaces.ParagraphCollectionUpdateData	Интерфейс обновления данных в объекте ParagraphCollection для использования в paragraphCollection.set({ ... }).
OneNote.Interfaces.ParagraphData	Интерфейс, описывающий данные, возвращаемые вызовом paragraph.toJSON().
OneNote.Interfaces.ParagraphLoadOptions	Контейнер для контента, отображаемого на странице. Объект Paragraph может содержать контент с любым типом ParagraphType.
OneNote.Interfaces.ParagraphUpdateData	Интерфейс обновления данных об объекте Paragraph для использования в paragraph.set({ ... }).
OneNote.Interfaces.PointCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом pointCollection.toJSON().
OneNote.Interfaces.PointCollectionLoadOptions	Представляет коллекцию объектов Point.
OneNote.Interfaces.PointCollectionUpdateData	Интерфейс обновления данных об объекте PointCollection для использования в pointCollection.set({ ... }).
OneNote.Interfaces.PointData	Интерфейс, описывающий данные, возвращаемые вызовом point.toJSON().
OneNote.Interfaces.PointLoadOptions	Представляет одну точку росчерка пера
OneNote.Interfaces.RichTextData	Интерфейс, описывающий данные, возвращаемые вызовом richText.toJSON().
OneNote.Interfaces.RichTextLoadOptions	Представляет объект RichText в объекте Paragraph.
OneNote.Interfaces.SectionCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом sectionCollection.toJSON().
OneNote.Interfaces.SectionCollectionLoadOptions	Представляет коллекцию разделов.
OneNote.Interfaces.SectionCollectionUpdateData	Интерфейс обновления данных об объекте SectionCollection для использования в sectionCollection.set({ ... }).
OneNote.Interfaces.SectionData	Интерфейс, описывающий данные, возвращаемые вызовом section.toJSON().
OneNote.Interfaces.SectionGroupCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом sectionGroupCollection.toJSON().
OneNote.Interfaces.SectionGroupCollectionLoadOptions	Представляет коллекцию групп разделов.
OneNote.Interfaces.SectionGroupCollectionUpdateData	Интерфейс обновления данных об объекте SectionGroupCollection для использования в sectionGroupCollection.set({ ... }).
OneNote.Interfaces.SectionGroupData	Интерфейс, описывающий данные, возвращаемые вызовом sectionGroup.toJSON().
OneNote.Interfaces.SectionGroupLoadOptions	Представляет группу разделов OneNote. Объекты SectionGroup могут содержать объекты Section и другие объекты SectionGroup.
OneNote.Interfaces.SectionLoadOptions	Представляет раздел в OneNote. Разделы могут содержать страницы.
OneNote.Interfaces.TableCellCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом tableCellCollection.toJSON().
OneNote.Interfaces.TableCellCollectionLoadOptions	Содержит коллекцию объектов TableCell.
OneNote.Interfaces.TableCellCollectionUpdateData	Интерфейс обновления данных об объекте TableCellCollection для использования в tableCellCollection.set({ ... }).
OneNote.Interfaces.TableCellData	Интерфейс, описывающий данные, возвращаемые вызовом tableCell.toJSON().
OneNote.Interfaces.TableCellLoadOptions	Представляет ячейку в таблице OneNote.
OneNote.Interfaces.TableCellUpdateData	Интерфейс обновления данных об объекте TableCell для использования в tableCell.set({ ... }).
OneNote.Interfaces.TableData	Интерфейс, описывающий данные, возвращаемые вызовом table.toJSON().
OneNote.Interfaces.TableLoadOptions	Представляет таблицу на странице OneNote.
OneNote.Interfaces.TableRowCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом tableRowCollection.toJSON().
OneNote.Interfaces.TableRowCollectionLoadOptions	Содержит коллекцию объектов TableRow.
OneNote.Interfaces.TableRowCollectionUpdateData	Интерфейс обновления данных об объекте TableRowCollection для использования в tableRowCollection.set({ ... }).
OneNote.Interfaces.TableRowData	Интерфейс, описывающий данные, возвращаемые вызовом tableRow.toJSON().
OneNote.Interfaces.TableRowLoadOptions	Представляет строку в таблице.
OneNote.Interfaces.TableUpdateData	Интерфейс обновления данных об объекте Table для использования в table.set({ ... }).
OneNote.ParagraphInfo	Список сведений для абзаца.

Перечисления

OneNote.ErrorCodes

OneNote.EventType

OneNote.InsertLocation

OneNote.ListType

OneNote.NoteTagStatus

OneNote.NoteTagType

OneNote.NumberType

OneNote.PageContentType

OneNote.ParagraphStyle

OneNote.ParagraphType

Функции

OneNote.run(batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью OneNote, используя новый контекст запроса. Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
OneNote.run(object, batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью OneNote, используя контекст запроса ранее созданного объекта API.
OneNote.run(objects, batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью 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>

Примеры

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await OneNote.run(async (context) => {
    const notebook = context.application.getActiveNotebook();
    // Interact with the OneNote notebook...
});

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

OfficeExtension.ClientObject[]

batch

(context: OneNote.RequestContext) => Promise<T>

Функция, которая принимает OneNote.RequestContext и возвращает промис (как правило, просто результат "context.sync()"). Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

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

Promise<T>