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

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

  • Статья

Набор 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.2 — это набор обязательных только для настольных компьютеров. Это надмножество WordApi 1.9 и WordApiDesktop 1.1.

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

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

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

Важно!

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

Список API

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

Класс Поля Описание
Основной текст shapes Возвращает коллекцию объектов фигур в тексте, включая как встроенные, так и плавающие фигуры.
Canvas id Возвращает целое число, представляющее идентификатор холста.
shape Возвращает объект Shape, связанный с холстом.
shapes Возвращает коллекцию объектов Shape.
Документ activeWindow Возвращает активное окно для документа.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Отображает знаки редакции, указывающие, где указанный документ отличается от другого документа.
виндоус Возвращает коллекцию Word.Window объектов для документа.
InsertShapeOptions height Представляет высоту вставленной фигуры.
left Представляет левое положение вставляемой фигуры.
top Представляет верхнюю позицию вставляемой фигуры.
width Представляет ширину вставляемой фигуры.
Page getNext() Возвращает следующую страницу в области.
getNextOrNullObject() Возвращает следующую страницу.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Целое" | "Пуск" | "End") Возвращает всю страницу или начальную или конечную точку страницы в виде диапазона.
height Возвращает высоту (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.
index Возвращает индекс страницы.
width Возвращает ширину (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.
PageCollection getFirst() Возвращает первую страницу в этой коллекции.
getFirstOrNullObject() Возвращает первую страницу в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Оконное стекло getNext() Возвращает следующую панель в окне.
getNextOrNullObject() Возвращает следующую область.
pages Возвращает коллекцию страниц в области.
pagesEnclosingViewport Возвращает объект , PageCollection показанный в окне просмотра области.
PaneCollection getFirst() Возвращает первую панель в этой коллекции.
getFirstOrNullObject() Возвращает первую панель в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающий холст перед текстом с привязкой в начале абзаца.
insertGeometricShape(geometryShapeType: Word. GeometryShapeType, insertShapeOptions?: Word. InsertShapeOptions) Вставляет геометрическую фигуру перед текстом с привязкой в начале абзаца.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающее изображение перед текстом с привязкой в начале абзаца.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающее текстовое поле перед текстом с привязкой в начале абзаца.
shapes Возвращает коллекцию объектов фигур, закрепленных в абзаце, включая как встроенные, так и плавающие фигуры.
Range insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающий холст перед текстом с привязкой в начале диапазона.
insertGeometricShape(geometryShapeType: Word. GeometryShapeType, insertShapeOptions?: Word. InsertShapeOptions) Вставляет геометрическую фигуру перед текстом с привязкой в начале диапазона.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающий рисунок перед текстом с привязкой в начале диапазона.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Вставляет плавающее текстовое поле перед текстом с привязкой в начале диапазона.
pages Возвращает коллекцию страниц в диапазоне.
shapes Возвращает коллекцию объектов фигур, привязанных в диапазоне, включая как встроенные, так и плавающие фигуры.
Shape allowOverlap Указывает, может ли данная фигура перекрывать другие фигуры.
altTextDescription Задает строку, представляющую альтернативный текст, связанный с фигурой.
body Представляет основной объект фигуры.
холст Возвращает холст, связанный с фигурой.
delete() Удаляет фигуру и ее содержимое.
fill Возвращает форматирование заливки фигуры.
geometricShapeType Тип геометрической фигуры фигуры.
height Высота фигуры в точках.
heightRelative Процент от высоты фигуры до вертикального относительного размера см. Word. RelativeSize.
id Возвращает целое число, представляющее идентификатор фигуры.
isChild Проверьте, является ли эта фигура дочерним элементом фигуры группы или фигуры холста.
left Расстояние (в точках) от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition.
leftRelative Относительная левая позиция в процентах от левой стороны фигуры до горизонтальной относительной позиции см. Word. RelativeHorizontalPosition.
lockAspectRatio Указывает, заблокировано ли пропорции этой фигуры.
moveHorizontally(distance: number) Перемещает фигуру по горизонтали на количество точек.
moveVertically(distance: number) Перемещает фигуру по вертикали на количество точек.
name Имя фигуры.
parentCanvas Возвращает форму родительского холста верхнего уровня для этой дочерней фигуры.
parentGroup Возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры.
relativeHorizontalPosition Относительное горизонтальное положение фигуры.
relativeHorizontalSize Относительный размер фигуры по горизонтали.
relativeVerticalPosition Относительное вертикальное положение фигуры.
relativeVerticalSize Относительный вертикальный размер фигуры.
rotation Задает поворот фигуры в градусах.
scaleHeight(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Масштабирует высоту фигуры с применением указанного коэффициента.
scaleWidth(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Масштабирует ширину фигуры с применением указанного коэффициента.
select(selectMultipleShapes?: boolean) Выбирает фигуру.
shapeGroup Возвращает группу фигур, связанную с фигурой.
textFrame Возвращает объект текстового кадра фигуры.
textWrap Возвращает форматирование фигуры в оболочке текста.
top Расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition.
topRelative Относительная верхняя позиция в процентах от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition.
type Возвращает тип фигуры.
visible Указывает, видна ли фигура.
width Ширина фигуры в точках.
widthRelative Процент ширины фигуры от горизонтального относительного размера см. Word. RelativeSize.
ShapeCollection getByGeometricTypes(types: Word. GeometryShapeType[]) Возвращает фигуры, имеющие указанные геометрические типы.
getById(id: number) Получает фигуру по идентификатору.
getByIdOrNullObject(id: number) Получает фигуру по идентификатору.
getByIds(ids: number[]) Получает фигуры по идентификаторам.
getByNames(names: string[]) Возвращает фигуры с указанными именами.
getByTypes(types: Word. ShapeType[]) Возвращает фигуры, имеющие указанные типы.
getFirst() Возвращает первую фигуру в этой коллекции.
getFirstOrNullObject() Возвращает первую фигуру в этой коллекции.
group() Группы фигур с плавающей линией в этой коллекции, встроенные фигуры будут пропущены.
items Получает загруженные дочерние элементы в этой коллекции.
ShapeFill backgroundColor Задает цвет фона заливки фигуры.
clear() Очищает форматирование заливки этой фигуры и задает для нее значение Word.ShapeFillType.NoFill;
foregroundColor Задает цвет переднего плана заливки фигуры.
setSolidColor(color: string) Задает заливку одним цветом для фигуры.
transparency Задает процент прозрачности заливки в виде значения от 0,0 (непрозрачный) до 1,0 (очистить).
type Возвращает тип заливки фигуры.
ShapeGroup id Возвращает целое число, представляющее идентификатор группы фигур.
shape Возвращает объект Shape, связанный с группой.
shapes Возвращает коллекцию объектов Shape.
ungroup() Отменяет группировку любых сгруппированных фигур в указанной группе фигур.
ShapeTextWrap bottomDistance Указывает расстояние (в точках) между текстом документа и нижним краем области, свободной от текста, вокруг указанной фигуры.
leftDistance Указывает расстояние (в точках) между текстом документа и левым краем области, свободной от текста, вокруг указанной фигуры.
rightDistance Указывает расстояние (в точках) между текстом документа и правым краем области, свободной от текста, вокруг указанной фигуры.
сторона Указывает, следует ли переносить текст документа с обеих сторон указанной фигуры, только с левой или правой стороны или на стороне фигуры, наиболее удаленной от поля страницы.
topDistance Указывает расстояние (в точках) между текстом документа и верхним краем области, свободной от текста, вокруг указанной фигуры.
type Указывает тип обтекателя текста вокруг фигуры.
TextFrame autoSizeSetting Параметры автоматического изменения размера текстового фрейма.
bottomMargin Представляет нижнее поле рамки с текстом (в пунктах).
hasText Указывает, содержит ли текстовый фрейм текст.
leftMargin Представляет левое поле рамки с текстом (в пунктах).
noTextRotation Возвращает значение True, если текст в текстовом фрейме не должен поворачиваться при повороте фигуры.
orientation Представляет угол, на который ориентирован текст для текстового фрейма.
rightMargin Представляет правое поле рамки с текстом (в пунктах).
topMargin Представляет верхнее поле рамки с текстом (в пунктах).
verticalAlignment Представляет вертикальное выравнивание для рамки с текстом.
wordWrap Определяет, разбиваются ли строки автоматически для размещения текста внутри фигуры.
Window activePane Возвращает активную область в окне.
Панели Возвращает коллекцию панелей в окне.
WindowCollection getFirst() Возвращает первое окно в этой коллекции.
getFirstOrNullObject() Возвращает первое окно в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.

См. также