Word.Interfaces.ShapeCollectionLoadOptions interface

Пакет:

word

Примечание

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

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

Комментарии

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

Свойства

$all	Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).
body	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.
geometricShapeType	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: тип геометрической фигуры фигуры. Он будет иметь значение NULL, если не является геометрической фигурой.
height	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: высота фигуры в точках.
id	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает целое число, представляющее идентификатор фигуры.
isChild	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: проверьте, является ли эта фигура дочерней фигурой группы или фигурой холста.
left	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от левой стороны фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной фигуры она вернет 0 и не может быть задана.
name	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: имя фигуры.
parentGroup	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если это не дочерняя фигура.
relativeHorizontalPosition	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное горизонтальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.
relativeVerticalPosition	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: относительное вертикальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeVerticalPosition.
shapeGroup	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства isNullObject , true будет возвращен, если тип фигуры не является "GroupShape". Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
top	Для каждого элемента в коллекции: расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной фигуры она вернет 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 (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

geometricShapeType

Примечание

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

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

geometricShapeType?: boolean;

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

boolean

Комментарии

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

height

Примечание

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

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

height?: boolean;

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

boolean

Комментарии

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

id

Примечание

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

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

id?: boolean;

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

boolean

Комментарии

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

isChild

Примечание

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

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

isChild?: boolean;

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

boolean

Комментарии

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

left

Примечание

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

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

left?: boolean;

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

boolean

Комментарии

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

name

Примечание

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

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

name?: boolean;

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

boolean

Комментарии

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

parentGroup

Примечание

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

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

parentGroup?: Word.Interfaces.ShapeLoadOptions;

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

Word.Interfaces.ShapeLoadOptions

Комментарии

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

relativeHorizontalPosition

Примечание

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

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

relativeHorizontalPosition?: boolean;

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

boolean

Комментарии

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

relativeVerticalPosition

Примечание

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

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

relativeVerticalPosition?: boolean;

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

boolean

Комментарии

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

shapeGroup

Примечание

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства isNullObject , true будет возвращен, если тип фигуры не является "GroupShape". Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

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

Word.Interfaces.ShapeGroupLoadOptions

Комментарии

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

top

Примечание

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

Для каждого элемента в коллекции: расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной фигуры она вернет 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 (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]