Word.Interfaces.ShapeLoadOptions interface

Пакет:

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 ]