Share via

Набор обязательных требований 1.4 для API JavaScript для скрытого документа Word

  • Статья

Набор WordApiHiddenDocument 1.4 требований — это специальный набор требований, включающий функции, доступные только для Word в Windows и mac. API в этом наборе требований считаются рабочими API для приложения Word в Windows и на Mac. Они следуют политикам поддержки разработчиков Microsoft 365. WordApiHiddenDocument API-интерфейсы считаются "предварительными" API для других платформ (веб- и iPad) и не поддерживаются ни одной из этих платформ.

Если API-интерфейсы в наборе WordApiHiddenDocument требований поддерживаются на всех платформах, они будут добавлены в последующий выпущенный набор требований (WordApi 1.[FUTURE]) и больше не помечены как WordApiHiddenDocument. Это можно рассматривать как аналогичный процесс продвижения API, переходя от предварительной версии к выпуску.

Важно!

WordApiHiddenDocument 1.4 — это надмножество наборов обязательных элементов WordApi 1.4 и WordApiHiddenDocument 1.3, а также набор обязательных элементов только для настольных компьютеров.

Так как WordApiHiddenDocument API-интерфейсы поддерживаются только Word в Windows и на Mac, надстройка должна проверить, поддерживается ли набор требований, прежде чем вызывать эти API. Это позволяет избежать попыток использования API только для настольных компьютеров на неподдерживаемой платформе.

if (Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.4")) {
   // Any API exclusive to this desktop-only requirement set.
}

После того как API входит в кроссплатформенный набор требований, следует удалить или изменить isSetSupported проверку. Это позволит включить функцию надстройки на других платформах. Обязательно протестируйте функцию на этих платформах при внесении этого изменения.

Важно!

Манифест не может быть указан WordApiHiddenDocument 1.4 в качестве требования активации. Это недопустимое значение для использования в элементе Set.

Список API

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

Класс Поля Описание
DocumentCreated customXmlParts Возвращает пользовательские XML-части в документе.
deleteBookmark(name: string) Удаляет закладку, если она существует, из документа.
getBookmarkRange(name: string) Возвращает диапазон закладки.
getBookmarkRangeOrNullObject(name: string) Возвращает диапазон закладки.
settings Возвращает параметры надстройки в документе.

См. также