Word api JavaScript (предварительная версия)

  • Статья

Новые WORD API JavaScript впервые появляются в предварительной версии, а затем становятся частью определенного нумерованного набора требований после того, как будет выполняться достаточное тестирование и получены отзывы пользователей.

Важно!

Обратите внимание, что на следующих платформах могут быть доступны следующие API Word предварительной версии.

  • Word для Windows
  • Word для Mac

API Word предварительной версии в настоящее время не поддерживаются на iPad. Однако в Word в Интернете также может быть доступно несколько API. Api, доступные только в Word в Интернете, см. в списке API только для интернета.

Примечание.

API предварительной версии могут быть изменены и не предназначены для использования в рабочей среде. Рекомендуется использовать их только в тестовой среде и среде разработки. Не используйте API предварительной версии в рабочей среде или в важных деловых документах.

Чтобы использовать API предварительной версии:

Список API

В следующей таблице перечислены Word API JavaScript, которые в настоящее время находятся в предварительной версии, за исключением тех, которые доступны только в Word в Интернете. Полный список всех API JavaScript Word (включая предварительные версии API и ранее выпущенные API) см. в статье Все api JavaScript Word.

Класс Поля Описание
AnnotationPopupActionEventArgs action Указывает выбранное действие во всплывающем меню.
критикаSuggestion Указывает принятое предложение (заполняется только при принятии предложения критики).
id Указывает идентификатор заметки, для которой было запущено событие.
Border color Задает цвет границы.
location Возвращает расположение границы.
type Указывает тип границы для границы.
visible Указывает, является ли граница видимой.
width Задает ширину границы.
BorderCollection getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Top" | "Left" | "Дно" | "Right" | "InsideHorizontal" | "InsideVertical") Возвращает границу с указанным расположением.
getFirst() Возвращает первую границу в этой коллекции.
getFirstOrNullObject() Возвращает первую границу в этой коллекции.
getItem(index: number) Возвращает объект Border по индексу в коллекции.
insideBorderColor Задает 24-разрядный цвет внутренних границ.
insideBorderType Указывает тип границы внутренней границы.
insideBorderWidth Задает ширину внутренних границ.
items Получает загруженные дочерние элементы в этой коллекции.
outsideBorderColor Задает 24-разрядный цвет внешних границ.
outsideBorderType Указывает тип границы внешних границ.
outsideBorderWidth Задает ширину внешних границ.
ContentControlAddedEventArgs eventType Тип события.
ContentControlDataChangedEventArgs eventType Тип события.
ContentControlDeletedEventArgs eventType Тип события.
ContentControlEnteredEventArgs eventType Тип события.
ContentControlEventArgs contentControl Объект, который вызвал событие.
eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlExitedEventArgs eventType Тип события.
ContentControlSelectionChangedEventArgs eventType Тип события.
Критика всплывающие окнаПараметры Указывает поведение всплывающего меню для критики.
CritiquePopupOptions brandingTextResourceId Возвращает идентификатор ресурса манифеста строки, используемой для фирменной символики.
subtitleResourceId Возвращает идентификатор ресурса манифеста строки, используемой в качестве подзаголовка.
Предложения Возвращает предложения, отображаемые во всплывающем меню "Критика".
titleResourceId Возвращает идентификатор ресурса манифеста строки, используемой в качестве заголовка.
Документ compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Отображает знаки редакции, указывающие, где указанный документ отличается от другого документа.
onAnnotationPopupAction Происходит, когда пользователь выполняет действие во всплывающем меню заметки.
DocumentCompareOptions addToRecentFiles True добавляет документ в список недавно использовавшихся файлов в меню Файл.
authorName Имя рецензента, связанное с различиями, вызванными сравнением.
compareTarget Целевой документ для сравнения.
detectFormatChanges Значение true (по умолчанию) для сравнения для включения обнаружения изменений формата.
ignoreAllComparisonWarnings Значение True сравнивает документы, не уведомляя пользователя о проблемах.
removeDateAndTime Значение True удаляет данные меток даты и времени из отслеживаемых изменений в возвращенном объекте Document.
removePersonalInformation Значение True удаляет все сведения о пользователе из комментариев, редакций и диалогового окна свойств в возвращенном объекте Document.
Поле showCodes Указывает, отображаются ли коды полей для указанного поля.
Font hidden Указывает значение, указывающее, помечен ли шрифт как скрытый.
InlinePicture imageFormat Возвращает формат встроенного изображения.
List getLevelFont(level: number) Возвращает шрифт маркера, номера или рисунка на указанном уровне в списке.
getLevelPicture(level: number) Возвращает строковое представление рисунка в кодировке Base64 на указанном уровне в списке.
resetLevelFont(level: number, resetFontName?: boolean) Сбрасывает шрифт маркера, числа или рисунка на указанном уровне в списке.
setLevelPicture(level: number, base64EncodedImage?: string) Задает рисунок на указанном уровне в списке.
ListLevel Трассы Задает горизонтальное выравнивание уровня списка.
font Возвращает объект Font, представляющий форматирование символов указанного объекта.
linkedStyle Указывает имя стиля, связанного с указанным объектом уровня списка.
numberFormat Задает числовой формат для указанного уровня списка.
numberPosition Задает позицию (в точках) номера или маркера для указанного объекта уровня списка.
numberStyle Задает стиль номера для объекта уровня списка.
resetOnHigher Указывает уровень списка, который должен появиться до того, как указанный уровень списка перезапустит нумеровку с 1.
startAt Указывает начальный номер для указанного объекта уровня списка.
tabPosition Задает позицию табуляции для указанного объекта уровня списка.
textPosition Задает позицию (в точках) для второй строки текста-оболочки для указанного объекта уровня списка.
trailingCharacter Указывает символ, вставленный после номера для указанного уровня списка.
ListLevelCollection getFirst() Возвращает первый уровень списка в этой коллекции.
getFirstOrNullObject() Возвращает первый уровень списка в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
ListTemplate listLevels Возвращает коллекцию ListLevels, представляющую все уровни для указанного объекта ListTemplate.
outlineNumbered Указывает, является ли указанный объект ListTemplate нумерованным.
ParagraphAddedEventArgs type Тип события.
ParagraphChangedEventArgs type Тип события.
ParagraphDeletedEventArgs type Тип события.
Range highlight() Временно выделяет диапазон без изменения содержимого документа.
removeHighlight() Удаляет выделение, добавленное функцией "Выделить", если таковой есть.
Shading foregroundPatternColor Задает цвет для переднего плана объекта.
Текстуры Задает текстуру затенения объекта.
Style borders Указывает объект BorderCollection, представляющий все границы для указанного стиля.
description Возвращает описание указанного стиля.
listTemplate Возвращает объект ListTemplate, представляющий форматирование списка для указанного объекта Style.
TableRow insertContentControl() Вставляет элемент управления содержимым в строку.
TableStyle Трассы Указывает выравнивание таблицы по краю страницы.
allowBreakAcrossPage Указывает, разбиваются ли строки в таблицах, отформатированных с заданным стилем, между страницами.

Список API только для веб-сайтов

В следующей таблице перечислены Word API JavaScript, которые в настоящее время находятся в предварительной версии только в Word в Интернете. Полный список всех API JavaScript Word (включая предварительные версии API и ранее выпущенные API) см. в статье Все api JavaScript Word.

Класс Поля Описание
Основной текст onCommentAdded Происходит при добавлении новых комментариев.
onCommentChanged Происходит при изменении комментария или его ответа.
onCommentDeleted Происходит при удалении комментариев.
onCommentDeselected Происходит при отмене выбора комментария.
onCommentSelected Происходит при выборе комментария.
CommentDetail id Представляет идентификатор этого комментария.
replyIds Представляет идентификаторы ответов на этот комментарий.
CommentEventArgs changeType Представляет, как активируется событие изменения примечания.
commentDetails Возвращает массив CommentDetail, содержащий идентификаторы и идентификаторы ответов участвующих комментариев.
источник Источник события.
type Тип события.
ContentControl onCommentAdded Происходит при добавлении новых комментариев.
onCommentChanged Происходит при изменении комментария или его ответа.
onCommentDeselected Происходит при отмене выбора комментария.
onCommentSelected Происходит при выборе комментария.
Paragraph onCommentAdded Происходит при добавлении новых комментариев.
onCommentChanged Происходит при изменении комментария или его ответа.
onCommentDeleted Происходит при удалении комментариев.
onCommentDeselected Происходит при отмене выбора комментария.
onCommentSelected Происходит при выборе комментария.
Range onCommentAdded Происходит при добавлении новых комментариев.
onCommentChanged Происходит при изменении комментария или его ответа.
onCommentDeselected Происходит при отмене выбора комментария.
onCommentSelected Происходит при выборе комментария.

См. также