Word api JavaScript (предварительная версия)
Новые WORD API JavaScript впервые появляются в предварительной версии, а затем становятся частью определенного нумерованного набора требований после того, как будет выполняться достаточное тестирование и получены отзывы пользователей.
Важно!
Обратите внимание, что на следующих платформах могут быть доступны следующие API Word предварительной версии.
- Word для Windows
- Word для Mac
API Word предварительной версии в настоящее время не поддерживаются на iPad. Однако в Word в Интернете также может быть доступно несколько API. Api, доступные только в Word в Интернете, см. в списке API только для интернета.
Примечание.
API предварительной версии могут быть изменены и не предназначены для использования в рабочей среде. Рекомендуется использовать их только в тестовой среде и среде разработки. Не используйте API предварительной версии в рабочей среде или в важных деловых документах.
Чтобы использовать API предварительной версии:
- Необходимо использовать предварительную версию библиотеки API JavaScript для Office из сети доставки содержимого (CDN)Office.js.
Файл определения типа для компиляции TypeScript и IntelliSense находится в сети CDN и имеет тип DefinitelyTyped. Эти типы можно установить с
npm install --save-dev @types/office-js-previewпомощью (не забудьте удалить типы для@types/office-js, если они были установлены ранее). - Возможно, вам потребуется присоединиться к программе предварительной оценки Microsoft 365 для доступа к более поздним сборкам Office.
Список API
В следующей таблице перечислены Word API JavaScript, которые в настоящее время находятся в предварительной версии, за исключением тех, которые доступны только в Word в Интернете. Полный список всех API JavaScript Word (включая предварительные версии API и ранее выпущенные API) см. в статье Все api JavaScript Word.
| Класс | Поля | Описание |
|---|---|---|
| Основной текст | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | CheckBox | DropDownList | "ComboBox") | Заключает объект Body в элемент управления содержимым. |
| ComboBoxContentControl | addListItem(displayText: string, value?: string, index?: number) | Добавляет новый элемент списка в этот элемент управления содержимым поля со списком и возвращает Word. Объект ContentControlListItem. |
| deleteAllListItems() | Удаляет все элементы списка в этом элементе управления содержимым поля со списком. | |
| listItems | Возвращает коллекцию элементов списка в элементе управления содержимым поля со списком. | |
| ContentControl | comboBoxContentControl | Указывает данные, связанные с полем со списком, если элемент управления содержимым имеет тип "ComboBox". |
| dropDownListContentControl | Указывает данные, связанные с раскрывающимся списком, если элемент управления содержимым имеет тип DropDownList. | |
| resetState() | Сбрасывает состояние элемента управления содержимым. | |
| setState(contentControlState: Word. ContentControlState) | Задает состояние элемента управления содержимым. | |
| ContentControlListItem | delete() | Обновляет папку списка с использованием внесенных изменений. |
| displayText | Указывает отображаемый текст элемента списка для раскрывающегося списка или элемента управления содержимым со списком. | |
| index | Указывает расположение индекса элемента списка элемента управления содержимым в коллекции элементов списка. | |
| select() | Выбирает элемент списка и задает для текста элемента управления содержимым значение элемента списка. | |
| value | Задает программное значение элемента списка для раскрывающегося списка или элемента управления содержимым со списком. | |
| ContentControlListItemCollection | getFirst() | Возвращает первый элемент списка в этой коллекции. |
| getFirstOrNullObject() | Возвращает первый элемент списка в этой коллекции. | |
| items | Получает загруженные дочерние элементы в этой коллекции. | |
| Документ | compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) | Отображает знаки редакции, указывающие, где указанный документ отличается от другого документа. |
| DropDownListContentControl | addListItem(displayText: string, value?: string, index?: number) | Добавляет новый элемент списка в этот элемент управления содержимым раскрывающегося списка и возвращает Word. Объект ContentControlListItem. |
| deleteAllListItems() | Удаляет все элементы списка в этом элементе управления содержимым раскрывающегося списка. | |
| listItems | Возвращает коллекцию элементов списка в элементе управления содержимым раскрывающегося списка. | |
| Font | hidden | Указывает значение, указывающее, помечен ли шрифт как скрытый. |
| Paragraph | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | CheckBox | DropDownList | "ComboBox") | Заключает объект Paragraph в элемент управления содержимым. |
| Range | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | CheckBox | DropDownList | "ComboBox") | Заключает объект Range в элемент управления содержимым. |
| Style | description | Возвращает описание указанного стиля. |
Список 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 | Происходит при выборе комментария. |
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins