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 |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.AnnotationCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.AnnotationData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.BodyData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.BodyLoadOptions |
Представляет содержимое документа или раздела. |
Word.Interfaces.BodyUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.BorderCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.BorderCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.BorderData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.BorderUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CheckboxContentControlData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CheckboxContentControlUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CollectionLoadOptions |
Предоставляет способы загрузки свойств только подмножества элементов коллекции. |
Word.Interfaces.CommentCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CommentCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CommentContentRangeData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CommentContentRangeUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CommentData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CommentReplyCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CommentReplyCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CommentReplyData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CommentReplyUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CommentUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ContentControlCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ContentControlCollectionLoadOptions |
Содержит коллекцию Word. Объекты ContentControl. Элементы управления контентом — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления форматированным текстом и содержимым обычного текста. |
Word.Interfaces.ContentControlCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ContentControlData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ContentControlLoadOptions |
Представляет элемент управления содержимым. Элементы управления содержимым — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления содержимым форматированного текста, обычного текста и флажка. |
Word.Interfaces.ContentControlUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CritiqueAnnotationData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomPropertyCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomPropertyCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CustomPropertyData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomPropertyUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CustomXmlPartCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.CustomXmlPartData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomXmlPartScopedCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.DocumentCreatedData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.DocumentCreatedUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.DocumentData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.DocumentLoadOptions |
Объект Document — это объект верхнего уровня. Объект Document содержит один или несколько разделов, элементы управления контентом и основной текст с содержанием документа. |
Word.Interfaces.DocumentPropertiesData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.DocumentPropertiesUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.DocumentUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.FieldCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.FieldCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.FieldData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.FieldUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.FontData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.FontLoadOptions |
Представляет шрифт. |
Word.Interfaces.FontUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.InlinePictureCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.InlinePictureCollectionLoadOptions |
Содержит коллекцию Word. Объекты InlinePicture. |
Word.Interfaces.InlinePictureCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.InlinePictureData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.InlinePictureLoadOptions |
Представляет встроенный рисунок. |
Word.Interfaces.InlinePictureUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ListCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ListData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListItemData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListItemUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ListLevelCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListLevelCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ListLevelData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListLevelUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ListTemplateData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ListTemplateUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.NoteItemCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.NoteItemCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.NoteItemData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.NoteItemUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ParagraphCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ParagraphCollectionLoadOptions |
Содержит коллекцию Word. Объекты абзаца. |
Word.Interfaces.ParagraphCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ParagraphData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ParagraphFormatData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ParagraphFormatUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ParagraphLoadOptions |
Представляет один абзац в выделении, диапазоне, элементе управления содержимым или тексте документа. |
Word.Interfaces.ParagraphUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.RangeCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.RangeCollectionLoadOptions |
Содержит коллекцию Word. Объекты range. |
Word.Interfaces.RangeCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.RangeData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.RangeLoadOptions |
Представляет непрерывную область в документе. |
Word.Interfaces.RangeUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.SearchOptionsData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.SearchOptionsLoadOptions |
Указывает параметры, которые необходимо включить в операцию поиска. Дополнительные сведения об использовании параметров поиска в API JavaScript Word см. в статье Использование параметров поиска для поиска текста в надстройке Word. |
Word.Interfaces.SearchOptionsUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.SectionCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.SectionCollectionLoadOptions |
Содержит коллекцию Word документа. Объекты section. |
Word.Interfaces.SectionCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.SectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.SectionLoadOptions |
Представляет раздел в документе Word. |
Word.Interfaces.SectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.SettingCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.SettingCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.SettingData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.SettingUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.ShadingData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.ShadingUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.StyleCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.StyleCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.StyleData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.StyleUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableBorderData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableBorderUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableCellCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableCellCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableCellData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableCellUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableRowCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableRowCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableRowData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableRowUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableStyleData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TableStyleUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TableUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TrackedChangeCollectionData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Word.Interfaces.TrackedChangeCollectionUpdateData |
Интерфейс для обновления данных объекта |
Word.Interfaces.TrackedChangeData |
Интерфейс, описывающий данные, возвращаемые путем вызова |
Перечисления
Word.Alignment | |
Word.BreakType |
Задает форму разрыва. |
Word.ContentControlAppearance |
Внешний вид ContentControl. |
Word.ContentControlType |
Указывает поддерживаемые типы и подтипы элементов управления содержимым. |
Word.ErrorCodes | |
Word.HeaderFooterType | |
Word.InsertLocation |
Типы расположения вставки. |
Word.SaveBehavior |
Указывает поведение сохранения для |
Word.SelectionMode |
Это перечисление задает место, где курсор (точка вставки) в документе находится после выделения. |
Word.UnderlineType |
Поддерживаемые стили для формата подчеркивания. |
Функции
Word. |
Выполняет пакетный скрипт, который выполняет действия в объектной модели Word, используя RequestContext ранее созданных объектов API. |
Word. |
Выполняет пакетный скрипт, который выполняет действия в объектной модели Word, используя RequestContext ранее созданного объекта API. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены. |
Word. |
Выполняет пакетный скрипт, который выполняет действия с объектной моделью 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
Массив ранее созданных объектов 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>
Office Add-ins