Word набор требований 1.5 для скрытых документов API JavaScript

  • Статья

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

Важно!

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

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

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

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

Важно!

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

Список API

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

Класс Поля Описание
DocumentCreated addStyle(name: string, type: Word. StyleType) Добавляет стиль в документ по имени и типу.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые элементы управления содержимым в документе.
getStyles() Возвращает объект StyleCollection, представляющий весь набор стилей документа.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End", insertFileOptions?: Word. InsertFileOptions) Вставляет документ в целевой документ в определенном расположении с дополнительными свойствами.
save(saveBehavior?: Word. SaveBehavior, fileName?: string) Сохраняет документ.

См. также