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

Word api JavaScript (предварительная версия)

  • Статья

Новые WORD API JavaScript впервые появляются в предварительной версии, а затем становятся частью определенного нумерованного набора требований после того, как будет выполняться достаточное тестирование и получены отзывы пользователей.

Важно!

Обратите внимание, что на следующих платформах могут быть доступны следующие API Word предварительной версии.

  • Word для Windows
  • Word для Mac

API Word предварительной версии в настоящее время не поддерживаются на iPad. Однако в Word в Интернете также может быть доступно несколько API. Api, доступные только в Word в Интернете, см. в списке API только для интернета.

Примечание.

API предварительной версии могут быть изменены и не предназначены для использования в рабочей среде. Рекомендуется использовать их только в тестовой среде и среде разработки. Не используйте API предварительной версии в рабочей среде или в важных деловых документах.

Чтобы использовать API предварительной версии:

Список API

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

Класс Поля Описание
Основной текст shapes Возвращает коллекцию объектов фигур в тексте, включая как встроенные, так и плавающие фигуры.
type Возвращает тип основного текста.
Canvas id Возвращает целое число, представляющее идентификатор холста.
shape Возвращает объект Shape, связанный с холстом.
shapes Возвращает коллекцию объектов Shape.
ContentControl resetState() Сбрасывает состояние элемента управления содержимым.
setState(contentControlState: Word. ContentControlState) Задает состояние элемента управления содержимым.
ContentControlAddedEventArgs eventType Тип события.
ContentControlDataChangedEventArgs eventType Тип события.
ContentControlDeletedEventArgs eventType Тип события.
ContentControlEnteredEventArgs eventType Тип события.
ContentControlExitedEventArgs eventType Тип события.
ContentControlSelectionChangedEventArgs eventType Тип события.
Документ activeWindow Возвращает активное окно для документа.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Отображает знаки редакции, указывающие, где указанный документ отличается от другого документа.
виндоус Возвращает коллекцию Word.Window объектов для документа.
Font hidden Указывает значение, указывающее, помечен ли шрифт как скрытый.
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() Возвращает первую страницу в этой коллекции.
getItem(index: number) Возвращает объект Page по индексу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Оконное стекло getNext() Возвращает следующую панель в окне.
getNextOrNullObject() Возвращает следующую область.
pages Возвращает коллекцию страниц в области.
pagesEnclosingViewport Возвращает объект , PageCollection показанный в окне просмотра области.
PaneCollection getFirst() Возвращает первую панель в этой коллекции.
getFirstOrNullObject() Возвращает первую панель в этой коллекции.
getItem(index: number) Возвращает объект Pane по индексу в коллекции.
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 Возвращает коллекцию объектов фигур, закрепленных в абзаце, включая как встроенные, так и плавающие фигуры.
ParagraphAddedEventArgs type Тип события.
ParagraphChangedEventArgs type Тип события.
ParagraphDeletedEventArgs type Тип события.
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 body Представляет основной объект фигуры.
холст Возвращает холст, связанный с фигурой.
delete() Удаляет фигуру и ее содержимое.
fill Возвращает формат заливки фигуры.
geometricShapeType Тип геометрической фигуры фигуры.
height Высота фигуры в точках.
id Возвращает целое число, представляющее идентификатор фигуры.
isChild Проверьте, является ли эта фигура дочерним элементом фигуры группы или фигуры холста.
left Расстояние (в точках) от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition.
moveHorizontally(distance: number) Перемещает фигуру по горизонтали на количество точек.
moveVertically(distance: number) Перемещает фигуру по вертикали на количество точек.
name Имя фигуры.
parentCanvas Возвращает форму родительского холста верхнего уровня для этой дочерней фигуры.
parentGroup Возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры.
relativeHorizontalPosition Относительное горизонтальное положение фигуры.
relativeVerticalPosition Относительное вертикальное положение фигуры.
select(selectMultipleShapes?: boolean) Выбирает фигуру.
shapeGroup Возвращает группу фигур, связанную с фигурой.
textFrame Возвращает объект текстового кадра фигуры.
top Расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition.
type Возвращает тип фигуры.
width Ширина фигуры в точках.
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() Отменяет группировку любых сгруппированных фигур в указанной группе фигур.
Style description Возвращает описание указанного стиля.
TextFrame autoSizeSetting Параметры автоматического изменения размера текстового фрейма.
bottomMargin Представляет нижнее поле рамки с текстом (в пунктах).
hasText Указывает, содержит ли текстовый фрейм текст.
leftMargin Представляет левое поле рамки с текстом (в пунктах).
noTextRotation Возвращает значение True, если текст в текстовом фрейме не должен поворачиваться при повороте фигуры.
orientation Представляет угол, на который ориентирован текст для текстового фрейма.
rightMargin Представляет правое поле рамки с текстом (в пунктах).
topMargin Представляет верхнее поле рамки с текстом (в пунктах).
verticalAlignment Представляет вертикальное выравнивание для рамки с текстом.
wordWrap Определяет, разбиваются ли строки автоматически для размещения текста внутри фигуры.
Window activePane Возвращает активную область в окне.
Панели Возвращает коллекцию панелей в окне.
WindowCollection getFirst() Возвращает первое окно в этой коллекции.
getFirstOrNullObject() Возвращает первое окно в этой коллекции.
getItem(index: number) Возвращает объект Window по индексу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.

Список 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 Происходит при выборе комментария.

См. также