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

Word.Interfaces.ShapeCollectionLoadOptions interface

  • Ссылка
Пакет:
word

Примечание

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

Содержит коллекцию Word. Объекты фигуры. В настоящее время поддерживаются только текстовые поля и геометрические фигуры.

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Свойства

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).
body

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.
height

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: высота фигуры в точках.
id

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает целое число, представляющее идентификатор фигуры.
left

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от левой стороны фигуры до горизонтального относительного положения. Для плавающей фигуры она вернет 0 и не может быть задана.
relativeHorizontalPosition

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное горизонтальное положение фигуры. Для плавающей фигуры ее нельзя задать.
relativeVerticalPosition

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное вертикальное положение фигуры. Для плавающей фигуры ее нельзя задать.
top

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от верхнего края фигуры до вертикального относительного положения. Для плавающей фигуры она вернет 0 и не может быть задана.
type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип фигуры. В настоящее время поддерживаются только текстовые поля и геометрические фигуры.
width

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: ширина фигуры в точках.

Сведения о свойстве

$all

Примечание

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

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

Значение свойства

boolean

body

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.

body?: Word.Interfaces.BodyLoadOptions;

Значение свойства

Word.Interfaces.BodyLoadOptions

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

height

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: высота фигуры в точках.

height?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

id

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает целое число, представляющее идентификатор фигуры.

id?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

left

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от левой стороны фигуры до горизонтального относительного положения. Для плавающей фигуры она вернет 0 и не может быть задана.

left?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

relativeHorizontalPosition

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное горизонтальное положение фигуры. Для плавающей фигуры ее нельзя задать.

relativeHorizontalPosition?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

relativeVerticalPosition

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное вертикальное положение фигуры. Для плавающей фигуры ее нельзя задать.

relativeVerticalPosition?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

top

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от верхнего края фигуры до вертикального относительного положения. Для плавающей фигуры она вернет 0 и не может быть задана.

top?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

type

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип фигуры. В настоящее время поддерживаются только текстовые поля и геометрические фигуры.

type?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

width

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: ширина фигуры в точках.

width?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]