Word.Interfaces.ShapeLoadOptions interface

Пакет:

word

Примечание

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

Представляет фигуру в нижнем колонтитуле или тексте документа. В настоящее время поддерживаются только текстовые поля и геометрические фигуры.

Комментарии

[ Набор 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 (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]