Поделиться через

Word набор обязательных для классических приложений API JavaScript 1.1

  • Статья

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

Если API в наборе WordApiDesktop требований поддерживаются на всех платформах, они будут добавлены в следующий выпущенный набор требований (WordApi 1.[NEXT]). После того как этот новый набор требований станет общедоступным, эти API-интерфейсы также будут по-прежнему помечены в этом WordApiDesktop наборе требований. Дополнительные сведения о требованиях для конкретной платформы в целом см. в статье Общие сведения о наборах требований для конкретной платформы.

Важно!

WordApiDesktop 1.1 — это набор обязательных только для настольных компьютеров. Это надмножество WordApi 1.8.

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

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

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

Важно!

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

Список API

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

Класс Поля Описание
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 Задает ширину внешних границ.
Документ compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Отображает знаки редакции, указывающие, где указанный документ отличается от другого документа.
importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word. ImportedStylesConflictBehavior) Импорт стилей из строки в формате JSON.
DocumentCompareOptions addToRecentFiles True добавляет документ в список недавно использовавшихся файлов в меню Файл.
authorName Имя рецензента, связанное с различиями, вызванными сравнением.
compareTarget Целевой документ для сравнения.
detectFormatChanges Значение true (по умолчанию) для сравнения для включения обнаружения изменений формата.
ignoreAllComparisonWarnings Значение True сравнивает документы, не уведомляя пользователя о проблемах.
removeDateAndTime Значение True удаляет данные меток даты и времени из отслеживаемых изменений в возвращенном объекте Document.
removePersonalInformation Значение True удаляет все сведения о пользователе из комментариев, редакций и диалогового окна свойств в возвращенном объекте Document.
Поле showCodes Указывает, отображаются ли коды полей для указанного поля.
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 нумерованным.
Shading foregroundPatternColor Задает цвет для переднего плана объекта.
текстура Задает текстуру затенения объекта.
Style borders Указывает объект BorderCollection, представляющий все границы для указанного стиля.
listTemplate Возвращает объект ListTemplate, представляющий форматирование списка для указанного объекта Style.
TableRow insertContentControl() Вставляет элемент управления содержимым в строку.
TableStyle выравнивание Указывает выравнивание таблицы по краю страницы.
allowBreakAcrossPage Указывает, разбиваются ли строки в таблицах, отформатированных с заданным стилем, между страницами.

См. также