word package

Классы

Word.Body	Представляет содержимое документа или раздела.
Word.ContentControl	Представляет элемент управления содержимым. Элементы управления содержимым — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления содержимым форматированного текста, обычного текста и флажка.
Word.ContentControlCollection	Содержит коллекцию Word. Объекты ContentControl. Элементы управления контентом — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления форматированным текстом и содержимым обычного текста.
Word.Document	Объект Document — это объект верхнего уровня. Объект Document содержит один или несколько разделов, элементы управления контентом и основной текст с содержанием документа.
Word.Font	Представляет шрифт.
Word.InlinePicture	Представляет встроенный рисунок.
Word.InlinePictureCollection	Содержит коллекцию Word. Объекты InlinePicture.
Word.Paragraph	Представляет один абзац в выделении, диапазоне, элементе управления содержимым или тексте документа.
Word.ParagraphCollection	Содержит коллекцию Word. Объекты абзаца.
Word.Range	Представляет непрерывную область в документе.
Word.RangeCollection	Содержит коллекцию Word. Объекты range.
Word.RequestContext	Объект RequestContext упрощает запросы к приложению Word. Так как надстройка Office и приложение Word выполняются в двух разных процессах, контекст запроса требуется для получения доступа к объектной модели Word из надстройки.
Word.SearchOptions	Указывает параметры, которые необходимо включить в операцию поиска. Дополнительные сведения об использовании параметров поиска в API JavaScript Word см. в статье Использование параметров поиска для поиска текста в надстройке Word.
Word.Section	Представляет раздел в документе Word.
Word.SectionCollection	Содержит коллекцию Word документа. Объекты section.

Интерфейсы

Word.Interfaces.AnnotationCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова annotationCollection.toJSON().
Word.Interfaces.AnnotationCollectionUpdateData	Интерфейс для обновления данных объекта AnnotationCollection для использования в annotationCollection.set({ ... }).
Word.Interfaces.AnnotationData	Интерфейс, описывающий данные, возвращаемые путем вызова annotation.toJSON().
Word.Interfaces.BodyData	Интерфейс, описывающий данные, возвращаемые путем вызова body.toJSON().
Word.Interfaces.BodyLoadOptions	Представляет содержимое документа или раздела.
Word.Interfaces.BodyUpdateData	Интерфейс для обновления данных объекта Body для использования в body.set({ ... }).
Word.Interfaces.BorderCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова borderCollection.toJSON().
Word.Interfaces.BorderCollectionUpdateData	Интерфейс для обновления данных объекта BorderCollection для использования в borderCollection.set({ ... }).
Word.Interfaces.BorderData	Интерфейс, описывающий данные, возвращаемые путем вызова border.toJSON().
Word.Interfaces.BorderUpdateData	Интерфейс для обновления данных объекта Border для использования в border.set({ ... }).
Word.Interfaces.CheckboxContentControlData	Интерфейс, описывающий данные, возвращаемые путем вызова checkboxContentControl.toJSON().
Word.Interfaces.CheckboxContentControlUpdateData	Интерфейс для обновления данных объекта CheckboxContentControl для использования в checkboxContentControl.set({ ... }).
Word.Interfaces.CollectionLoadOptions	Предоставляет способы загрузки свойств только подмножества элементов коллекции.
Word.Interfaces.CommentCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова commentCollection.toJSON().
Word.Interfaces.CommentCollectionUpdateData	Интерфейс для обновления данных объекта CommentCollection для использования в commentCollection.set({ ... }).
Word.Interfaces.CommentContentRangeData	Интерфейс, описывающий данные, возвращаемые путем вызова commentContentRange.toJSON().
Word.Interfaces.CommentContentRangeUpdateData	Интерфейс для обновления данных объекта CommentContentRange для использования в commentContentRange.set({ ... }).
Word.Interfaces.CommentData	Интерфейс, описывающий данные, возвращаемые путем вызова comment.toJSON().
Word.Interfaces.CommentReplyCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова commentReplyCollection.toJSON().
Word.Interfaces.CommentReplyCollectionUpdateData	Интерфейс для обновления данных объекта CommentReplyCollection для использования в commentReplyCollection.set({ ... }).
Word.Interfaces.CommentReplyData	Интерфейс, описывающий данные, возвращаемые путем вызова commentReply.toJSON().
Word.Interfaces.CommentReplyUpdateData	Интерфейс для обновления данных объекта CommentReply для использования в commentReply.set({ ... }).
Word.Interfaces.CommentUpdateData	Интерфейс для обновления данных объекта Comment для использования в comment.set({ ... }).
Word.Interfaces.ContentControlCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова contentControlCollection.toJSON().
Word.Interfaces.ContentControlCollectionLoadOptions	Содержит коллекцию Word. Объекты ContentControl. Элементы управления контентом — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления форматированным текстом и содержимым обычного текста.
Word.Interfaces.ContentControlCollectionUpdateData	Интерфейс для обновления данных объекта ContentControlCollection для использования в contentControlCollection.set({ ... }).
Word.Interfaces.ContentControlData	Интерфейс, описывающий данные, возвращаемые путем вызова contentControl.toJSON().
Word.Interfaces.ContentControlLoadOptions	Представляет элемент управления содержимым. Элементы управления содержимым — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления содержимым форматированного текста, обычного текста и флажка.
Word.Interfaces.ContentControlUpdateData	Интерфейс для обновления данных объекта ContentControl для использования в contentControl.set({ ... }).
Word.Interfaces.CritiqueAnnotationData	Интерфейс, описывающий данные, возвращаемые путем вызова critiqueAnnotation.toJSON().
Word.Interfaces.CustomPropertyCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова customPropertyCollection.toJSON().
Word.Interfaces.CustomPropertyCollectionUpdateData	Интерфейс для обновления данных объекта CustomPropertyCollection для использования в customPropertyCollection.set({ ... }).
Word.Interfaces.CustomPropertyData	Интерфейс, описывающий данные, возвращаемые путем вызова customProperty.toJSON().
Word.Interfaces.CustomPropertyUpdateData	Интерфейс для обновления данных объекта CustomProperty для использования в customProperty.set({ ... }).
Word.Interfaces.CustomXmlPartCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова customXmlPartCollection.toJSON().
Word.Interfaces.CustomXmlPartCollectionUpdateData	Интерфейс для обновления данных объекта CustomXmlPartCollection для использования в customXmlPartCollection.set({ ... }).
Word.Interfaces.CustomXmlPartData	Интерфейс, описывающий данные, возвращаемые путем вызова customXmlPart.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова customXmlPartScopedCollection.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	Интерфейс для обновления данных объекта CustomXmlPartScopedCollection для использования в customXmlPartScopedCollection.set({ ... }).
Word.Interfaces.DocumentCreatedData	Интерфейс, описывающий данные, возвращаемые путем вызова documentCreated.toJSON().
Word.Interfaces.DocumentCreatedUpdateData	Интерфейс для обновления данных объекта DocumentCreated для использования в documentCreated.set({ ... }).
Word.Interfaces.DocumentData	Интерфейс, описывающий данные, возвращаемые путем вызова document.toJSON().
Word.Interfaces.DocumentLoadOptions	Объект Document — это объект верхнего уровня. Объект Document содержит один или несколько разделов, элементы управления контентом и основной текст с содержанием документа.
Word.Interfaces.DocumentPropertiesData	Интерфейс, описывающий данные, возвращаемые путем вызова documentProperties.toJSON().
Word.Interfaces.DocumentPropertiesUpdateData	Интерфейс для обновления данных объекта DocumentProperties для использования в documentProperties.set({ ... }).
Word.Interfaces.DocumentUpdateData	Интерфейс для обновления данных объекта Document для использования в document.set({ ... }).
Word.Interfaces.FieldCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова fieldCollection.toJSON().
Word.Interfaces.FieldCollectionUpdateData	Интерфейс для обновления данных объекта FieldCollection для использования в fieldCollection.set({ ... }).
Word.Interfaces.FieldData	Интерфейс, описывающий данные, возвращаемые путем вызова field.toJSON().
Word.Interfaces.FieldUpdateData	Интерфейс для обновления данных объекта Field для использования в field.set({ ... }).
Word.Interfaces.FontData	Интерфейс, описывающий данные, возвращаемые путем вызова font.toJSON().
Word.Interfaces.FontLoadOptions	Представляет шрифт.
Word.Interfaces.FontUpdateData	Интерфейс для обновления данных объекта Font для использования в font.set({ ... }).
Word.Interfaces.InlinePictureCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова inlinePictureCollection.toJSON().
Word.Interfaces.InlinePictureCollectionLoadOptions	Содержит коллекцию Word. Объекты InlinePicture.
Word.Interfaces.InlinePictureCollectionUpdateData	Интерфейс для обновления данных объекта InlinePictureCollection для использования в inlinePictureCollection.set({ ... }).
Word.Interfaces.InlinePictureData	Интерфейс, описывающий данные, возвращаемые путем вызова inlinePicture.toJSON().
Word.Interfaces.InlinePictureLoadOptions	Представляет встроенный рисунок.
Word.Interfaces.InlinePictureUpdateData	Интерфейс для обновления данных объекта InlinePicture для использования в inlinePicture.set({ ... }).
Word.Interfaces.ListCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова listCollection.toJSON().
Word.Interfaces.ListCollectionUpdateData	Интерфейс для обновления данных объекта ListCollection для использования в listCollection.set({ ... }).
Word.Interfaces.ListData	Интерфейс, описывающий данные, возвращаемые путем вызова list.toJSON().
Word.Interfaces.ListItemData	Интерфейс, описывающий данные, возвращаемые путем вызова listItem.toJSON().
Word.Interfaces.ListItemUpdateData	Интерфейс для обновления данных объекта ListItem для использования в listItem.set({ ... }).
Word.Interfaces.ListLevelCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова listLevelCollection.toJSON().
Word.Interfaces.ListLevelCollectionUpdateData	Интерфейс для обновления данных объекта ListLevelCollection для использования в listLevelCollection.set({ ... }).
Word.Interfaces.ListLevelData	Интерфейс, описывающий данные, возвращаемые путем вызова listLevel.toJSON().
Word.Interfaces.ListLevelUpdateData	Интерфейс для обновления данных объекта ListLevel для использования в listLevel.set({ ... }).
Word.Interfaces.ListTemplateData	Интерфейс, описывающий данные, возвращаемые путем вызова listTemplate.toJSON().
Word.Interfaces.ListTemplateUpdateData	Интерфейс для обновления данных объекта ListTemplate для использования в listTemplate.set({ ... }).
Word.Interfaces.NoteItemCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова noteItemCollection.toJSON().
Word.Interfaces.NoteItemCollectionUpdateData	Интерфейс для обновления данных объекта NoteItemCollection для использования в noteItemCollection.set({ ... }).
Word.Interfaces.NoteItemData	Интерфейс, описывающий данные, возвращаемые путем вызова noteItem.toJSON().
Word.Interfaces.NoteItemUpdateData	Интерфейс для обновления данных объекта NoteItem для использования в noteItem.set({ ... }).
Word.Interfaces.ParagraphCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова paragraphCollection.toJSON().
Word.Interfaces.ParagraphCollectionLoadOptions	Содержит коллекцию Word. Объекты абзаца.
Word.Interfaces.ParagraphCollectionUpdateData	Интерфейс для обновления данных объекта ParagraphCollection для использования в paragraphCollection.set({ ... }).
Word.Interfaces.ParagraphData	Интерфейс, описывающий данные, возвращаемые путем вызова paragraph.toJSON().
Word.Interfaces.ParagraphFormatData	Интерфейс, описывающий данные, возвращаемые путем вызова paragraphFormat.toJSON().
Word.Interfaces.ParagraphFormatUpdateData	Интерфейс для обновления данных объекта ParagraphFormat для использования в paragraphFormat.set({ ... }).
Word.Interfaces.ParagraphLoadOptions	Представляет один абзац в выделении, диапазоне, элементе управления содержимым или тексте документа.
Word.Interfaces.ParagraphUpdateData	Интерфейс для обновления данных объекта Paragraph для использования в paragraph.set({ ... }).
Word.Interfaces.RangeCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова rangeCollection.toJSON().
Word.Interfaces.RangeCollectionLoadOptions	Содержит коллекцию Word. Объекты range.
Word.Interfaces.RangeCollectionUpdateData	Интерфейс для обновления данных объекта RangeCollection для использования в rangeCollection.set({ ... }).
Word.Interfaces.RangeData	Интерфейс, описывающий данные, возвращаемые путем вызова range.toJSON().
Word.Interfaces.RangeLoadOptions	Представляет непрерывную область в документе.
Word.Interfaces.RangeUpdateData	Интерфейс для обновления данных объекта Range для использования в range.set({ ... }).
Word.Interfaces.SearchOptionsData	Интерфейс, описывающий данные, возвращаемые путем вызова searchOptions.toJSON().
Word.Interfaces.SearchOptionsLoadOptions	Указывает параметры, которые необходимо включить в операцию поиска. Дополнительные сведения об использовании параметров поиска в API JavaScript Word см. в статье Использование параметров поиска для поиска текста в надстройке Word.
Word.Interfaces.SearchOptionsUpdateData	Интерфейс для обновления данных объекта SearchOptions для использования в searchOptions.set({ ... }).
Word.Interfaces.SectionCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова sectionCollection.toJSON().
Word.Interfaces.SectionCollectionLoadOptions	Содержит коллекцию Word документа. Объекты section.
Word.Interfaces.SectionCollectionUpdateData	Интерфейс для обновления данных объекта SectionCollection для использования в sectionCollection.set({ ... }).
Word.Interfaces.SectionData	Интерфейс, описывающий данные, возвращаемые путем вызова section.toJSON().
Word.Interfaces.SectionLoadOptions	Представляет раздел в документе Word.
Word.Interfaces.SectionUpdateData	Интерфейс для обновления данных объекта Section для использования в section.set({ ... }).
Word.Interfaces.SettingCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова settingCollection.toJSON().
Word.Interfaces.SettingCollectionUpdateData	Интерфейс для обновления данных объекта SettingCollection для использования в settingCollection.set({ ... }).
Word.Interfaces.SettingData	Интерфейс, описывающий данные, возвращаемые путем вызова setting.toJSON().
Word.Interfaces.SettingUpdateData	Интерфейс для обновления данных объекта Setting для использования в setting.set({ ... }).
Word.Interfaces.ShadingData	Интерфейс, описывающий данные, возвращаемые путем вызова shading.toJSON().
Word.Interfaces.ShadingUpdateData	Интерфейс для обновления данных объекта Shading для использования в shading.set({ ... }).
Word.Interfaces.StyleCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова styleCollection.toJSON().
Word.Interfaces.StyleCollectionUpdateData	Интерфейс для обновления данных объекта StyleCollection для использования в styleCollection.set({ ... }).
Word.Interfaces.StyleData	Интерфейс, описывающий данные, возвращаемые путем вызова style.toJSON().
Word.Interfaces.StyleUpdateData	Интерфейс для обновления данных объекта Style для использования в style.set({ ... }).
Word.Interfaces.TableBorderData	Интерфейс, описывающий данные, возвращаемые путем вызова tableBorder.toJSON().
Word.Interfaces.TableBorderUpdateData	Интерфейс для обновления данных объекта TableBorder для использования в tableBorder.set({ ... }).
Word.Interfaces.TableCellCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова tableCellCollection.toJSON().
Word.Interfaces.TableCellCollectionUpdateData	Интерфейс для обновления данных объекта TableCellCollection для использования в tableCellCollection.set({ ... }).
Word.Interfaces.TableCellData	Интерфейс, описывающий данные, возвращаемые путем вызова tableCell.toJSON().
Word.Interfaces.TableCellUpdateData	Интерфейс для обновления данных объекта TableCell для использования в tableCell.set({ ... }).
Word.Interfaces.TableCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова tableCollection.toJSON().
Word.Interfaces.TableCollectionUpdateData	Интерфейс для обновления данных объекта TableCollection для использования в tableCollection.set({ ... }).
Word.Interfaces.TableData	Интерфейс, описывающий данные, возвращаемые путем вызова table.toJSON().
Word.Interfaces.TableRowCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова tableRowCollection.toJSON().
Word.Interfaces.TableRowCollectionUpdateData	Интерфейс для обновления данных объекта TableRowCollection для использования в tableRowCollection.set({ ... }).
Word.Interfaces.TableRowData	Интерфейс, описывающий данные, возвращаемые путем вызова tableRow.toJSON().
Word.Interfaces.TableRowUpdateData	Интерфейс для обновления данных объекта TableRow для использования в tableRow.set({ ... }).
Word.Interfaces.TableStyleData	Интерфейс, описывающий данные, возвращаемые путем вызова tableStyle.toJSON().
Word.Interfaces.TableStyleUpdateData	Интерфейс для обновления данных объекта TableStyle для использования в tableStyle.set({ ... }).
Word.Interfaces.TableUpdateData	Интерфейс для обновления данных объекта Table для использования в table.set({ ... }).
Word.Interfaces.TrackedChangeCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова trackedChangeCollection.toJSON().
Word.Interfaces.TrackedChangeCollectionUpdateData	Интерфейс для обновления данных объекта TrackedChangeCollection для использования в trackedChangeCollection.set({ ... }).
Word.Interfaces.TrackedChangeData	Интерфейс, описывающий данные, возвращаемые путем вызова trackedChange.toJSON().

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

Word.Alignment
Word.BreakType	Задает форму разрыва.
Word.ContentControlAppearance	Внешний вид ContentControl.
Word.ContentControlType	Указывает поддерживаемые типы и подтипы элементов управления содержимым.
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation	Типы расположения вставки.
Word.SaveBehavior	Указывает поведение сохранения для Document.save.
Word.SelectionMode	Это перечисление задает место, где курсор (точка вставки) в документе находится после выделения.
Word.UnderlineType	Поддерживаемые стили для формата подчеркивания.

Функции

Word.run(objects, batch)	Выполняет пакетный скрипт, который выполняет действия в объектной модели Word, используя RequestContext ранее созданных объектов API.
Word.run(object, batch)	Выполняет пакетный скрипт, который выполняет действия в объектной модели Word, используя RequestContext ранее созданного объекта API. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
Word.run(batch)	Выполняет пакетный скрипт, который выполняет действия с объектной моделью Word с помощью нового объекта RequestContext. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

Сведения о функции

Word.run(objects, batch)

Выполняет пакетный скрипт, который выполняет действия в объектной модели Word, используя RequestContext ранее созданных объектов API.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Параметры

objects

OfficeExtension.ClientObject[]

Массив ранее созданных объектов API. Массив будет проверен, чтобы убедиться, что все объекты имеют один и тот же контекст. Пакет будет использовать этот общий requestContext, что означает, что любые изменения, примененные к этим объектам, будут приняты .context.sync()

batch

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

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат ).context.sync() Параметр контекста упрощает запросы к приложению Word. Так как надстройка Office и приложение Word выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели Word из надстройки.

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

Promise<T>

Word.run(object, batch)

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

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Параметры

object

OfficeExtension.ClientObject

Ранее созданный объект API. Пакет будет использовать тот же requestContext, что и переданный объект, что означает, что любые изменения, примененные к объекту, будут приняты .context.sync()

batch

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

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат ).context.sync() Параметр контекста упрощает запросы к приложению Word. Так как надстройка Office и приложение Word выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели Word из надстройки.

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

Promise<T>

Word.run(batch)

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

export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Параметры

batch

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

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат ).context.sync() Параметр контекста упрощает запросы к приложению Word. Так как надстройка Office и приложение Word выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели Word из надстройки.

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

Promise<T>