Word.Interfaces.ShapeCollectionLoadOptions interface

Пакет:

word

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

Замечания

[ Набор API: WordApiDesktop 1.2 ]

Свойства

$all	Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).
allowOverlap	Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Указывает, может ли данная фигура перекрывать другие фигуры.
altTextDescription	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает строку, представляющую альтернативный текст, связанный с фигурой.
body	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает Body объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.
canvas	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает холст, связанный с фигурой. Объект со свойством , для свойства isNullObject , true возвращается, если тип фигуры не canvasимеет значения . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
fill	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование заливки фигуры.
geometricShapeType	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает тип геометрической фигуры фигуры. Он будет иметь значение NULL, если не является геометрической фигурой.
height	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает высоту фигуры (в точках).
heightRelative	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает процент высоты фигуры относительного вертикального размера (то есть relativeVerticalSize свойства). Для встроенной или дочерней фигуры ее нельзя задать.
id	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает целое число, представляющее идентификатор фигуры.
isChild	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: проверьте, является ли эта фигура дочерней фигурой группы или фигурой холста.
left	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает расстояние (в точках) от левой стороны фигуры до относительного горизонтального положения (то есть relativeHorizontalPosition свойства). Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
leftRelative	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает относительную левую позицию в процентах от левой части фигуры до относительной горизонтальной позиции (то есть relativeHorizontalalPosition свойства). Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
lockAspectRatio	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, заблокировано ли пропорции этой фигуры.
name	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает имя фигуры.
parentCanvas	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форму родительского холста верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой холста.
parentGroup	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой группы.
relativeHorizontalPosition	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает относительное горизонтальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.
relativeHorizontalSize	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает относительный размер фигуры по горизонтали. Используйте со свойством widthRelative . Для встроенной или дочерней фигуры ее нельзя задать.
relativeVerticalPosition	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает относительное вертикальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeVerticalPosition.
relativeVerticalSize	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает относительный вертикальный размер фигуры. Используйте со свойством heightRelative . Для встроенной или дочерней фигуры ее нельзя задать.
rotation	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает поворот фигуры в градусах. Неприменимо к фигуре Canvas.
shapeGroup	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства isNullObject , true возвращается, если тип фигуры не groupShapeимеет значения . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
textFrame	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает TextFrame объект фигуры.
textWrap	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование обтекания текста фигуры.
top	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает расстояние (в точках) от верхнего края фигуры до относительного вертикального положения (т. е relativeVerticalPosition . свойства). Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
topRelative	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает относительную верхнюю позицию в процентах от верхнего края фигуры до относительной вертикальной relativeVerticalPosition позиции (то есть свойства). Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
type	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип фигуры. В настоящее время поддерживаются только следующие фигуры: текстовые поля, геометрические фигуры, группы, рисунки и холсты.
visible	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, видна ли фигура. Неприменимо к встроенным фигурам.
width	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает ширину фигуры (в точках).
widthRelative	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает процент ширины фигуры относительного горизонтального размера (то есть relativeHorizontalSize свойства). Для встроенной или дочерней фигуры ее нельзя задать.

Подробнее

$all

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

$all?: boolean;

Стоимость недвижимости

boolean

allowOverlap

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

allowOverlap?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

altTextDescription

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

altTextDescription?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

body

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

body?: Word.Interfaces.BodyLoadOptions;

Стоимость недвижимости

Word.Interfaces.BodyLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

canvas

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

canvas?: Word.Interfaces.CanvasLoadOptions;

Стоимость недвижимости

Word.Interfaces.CanvasLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

fill

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

fill?: Word.Interfaces.ShapeFillLoadOptions;

Стоимость недвижимости

Word.Interfaces.ShapeFillLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

geometricShapeType

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

geometricShapeType?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

height

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

height?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

heightRelative

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

heightRelative?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

id

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

id?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

isChild

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

isChild?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

left

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

left?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

leftRelative

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

leftRelative?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

lockAspectRatio

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

lockAspectRatio?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

name

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

name?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

parentCanvas

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

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

Стоимость недвижимости

Word.Interfaces.ShapeLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

parentGroup

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

parentGroup?: Word.Interfaces.ShapeLoadOptions;

Стоимость недвижимости

Word.Interfaces.ShapeLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeHorizontalPosition

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

relativeHorizontalPosition?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeHorizontalSize

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

relativeHorizontalSize?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeVerticalPosition

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

relativeVerticalPosition?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeVerticalSize

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

relativeVerticalSize?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

rotation

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

rotation?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

shapeGroup

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

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Стоимость недвижимости

Word.Interfaces.ShapeGroupLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

textFrame

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает TextFrame объект фигуры.

textFrame?: Word.Interfaces.TextFrameLoadOptions;

Стоимость недвижимости

Word.Interfaces.TextFrameLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

textWrap

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

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

Стоимость недвижимости

Word.Interfaces.ShapeTextWrapLoadOptions

Замечания

[ Набор API: WordApiDesktop 1.2 ]

top

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

top?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

topRelative

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

topRelative?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

type

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

type?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

visible

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

visible?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

width

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

width?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

widthRelative

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

widthRelative?: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]