Word.Interfaces.ShapeLoadOptions interface
Представляет фигуру в верхнем, нижнем колонтитуле или тексте документа. В настоящее время поддерживаются только следующие фигуры: текстовые поля, геометрические фигуры, группы, рисунки и холсты.
Комментарии
[ Набор API: WordApiDesktop 1.2 ]
Свойства
$all | Указание |
allow |
Указывает, может ли данная фигура перекрывать другие фигуры. |
alt |
Задает строку, представляющую альтернативный текст, связанный с фигурой. |
body | Представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам. |
canvas | Возвращает холст, связанный с фигурой. Объект со свойством |
fill | Возвращает форматирование заливки фигуры. |
geometric |
Тип геометрической фигуры фигуры. Он будет иметь значение NULL, если не является геометрической фигурой. |
height | Высота фигуры в точках. |
height |
Процент от высоты фигуры до вертикального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать. |
id | Возвращает целое число, представляющее идентификатор фигуры. |
is |
Проверьте, является ли эта фигура дочерним элементом фигуры группы или фигуры холста. |
left | Расстояние в точках от левой стороны фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла. |
left |
Относительное левое положение в процентах от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана. |
lock |
Указывает, заблокировано ли пропорции этой фигуры. |
name | Имя фигуры. |
parent |
Возвращает форму родительского холста верхнего уровня для этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой холста. |
parent |
Возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой группы. |
relative |
Относительное горизонтальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition. |
relative |
Относительный размер фигуры по горизонтали. Для встроенной или дочерней фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition. |
relative |
Относительное вертикальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeVerticalPosition. |
relative |
Относительный вертикальный размер фигуры. Для встроенной или дочерней фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition. |
rotation | Задает поворот фигуры в градусах. Неприменимо к фигуре Canvas. |
shape |
Возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства |
text |
Возвращает объект текстового кадра фигуры. |
text |
Возвращает форматирование фигуры в оболочке текста. |
top | Расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла. |
top |
Относительная верхняя позиция в процентах от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана. |
type | Возвращает тип фигуры. В настоящее время поддерживаются только следующие фигуры: текстовые поля, геометрические фигуры, группы, рисунки и холсты. |
visible | Указывает, видна ли фигура. Неприменимо к встроенным фигурам. |
width | Ширина фигуры в точках. |
width |
Процент от ширины фигуры до горизонтального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать. |
Сведения о свойстве
$all
Указание $all
для параметров загрузки загружает все скалярные свойства (например,Range.address
), но не свойства навигации (например, Range.format.fill.color
).
$all?: boolean;
Значение свойства
boolean
allowOverlap
Указывает, может ли данная фигура перекрывать другие фигуры.
allowOverlap?: boolean;
Значение свойства
boolean
Комментарии
altTextDescription
Задает строку, представляющую альтернативный текст, связанный с фигурой.
altTextDescription?: boolean;
Значение свойства
boolean
Комментарии
body
Представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.
body?: Word.Interfaces.BodyLoadOptions;
Значение свойства
Комментарии
canvas
Возвращает холст, связанный с фигурой. Объект со свойством isNullObject
, свойству , true
будет возвращен, если тип фигуры не является "Canvas". Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
canvas?: Word.Interfaces.CanvasLoadOptions;
Значение свойства
Комментарии
fill
Возвращает форматирование заливки фигуры.
fill?: Word.Interfaces.ShapeFillLoadOptions;
Значение свойства
Комментарии
geometricShapeType
Тип геометрической фигуры фигуры. Он будет иметь значение NULL, если не является геометрической фигурой.
geometricShapeType?: boolean;
Значение свойства
boolean
Комментарии
height
Высота фигуры в точках.
height?: boolean;
Значение свойства
boolean
Комментарии
heightRelative
Процент от высоты фигуры до вертикального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.
heightRelative?: boolean;
Значение свойства
boolean
Комментарии
id
Возвращает целое число, представляющее идентификатор фигуры.
id?: boolean;
Значение свойства
boolean
Комментарии
isChild
Проверьте, является ли эта фигура дочерним элементом фигуры группы или фигуры холста.
isChild?: boolean;
Значение свойства
boolean
Комментарии
left
Расстояние в точках от левой стороны фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
left?: boolean;
Значение свойства
boolean
Комментарии
leftRelative
Относительное левое положение в процентах от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
leftRelative?: boolean;
Значение свойства
boolean
Комментарии
lockAspectRatio
Указывает, заблокировано ли пропорции этой фигуры.
lockAspectRatio?: boolean;
Значение свойства
boolean
Комментарии
name
parentCanvas
Возвращает форму родительского холста верхнего уровня для этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой холста.
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
Значение свойства
Комментарии
parentGroup
Возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой группы.
parentGroup?: Word.Interfaces.ShapeLoadOptions;
Значение свойства
Комментарии
relativeHorizontalPosition
Относительное горизонтальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.
relativeHorizontalPosition?: boolean;
Значение свойства
boolean
Комментарии
relativeHorizontalSize
Относительный размер фигуры по горизонтали. Для встроенной или дочерней фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.
relativeHorizontalSize?: boolean;
Значение свойства
boolean
Комментарии
relativeVerticalPosition
Относительное вертикальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeVerticalPosition.
relativeVerticalPosition?: boolean;
Значение свойства
boolean
Комментарии
relativeVerticalSize
Относительный вертикальный размер фигуры. Для встроенной или дочерней фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.
relativeVerticalSize?: boolean;
Значение свойства
boolean
Комментарии
rotation
Задает поворот фигуры в градусах. Неприменимо к фигуре Canvas.
rotation?: boolean;
Значение свойства
boolean
Комментарии
shapeGroup
Возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства isNullObject
, true
будет возвращен, если тип фигуры не является "GroupShape". Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
Значение свойства
Комментарии
textFrame
Возвращает объект текстового кадра фигуры.
textFrame?: Word.Interfaces.TextFrameLoadOptions;
Значение свойства
Комментарии
textWrap
Возвращает форматирование фигуры в оболочке текста.
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
Значение свойства
Комментарии
top
Расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
top?: boolean;
Значение свойства
boolean
Комментарии
topRelative
Относительная верхняя позиция в процентах от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
topRelative?: boolean;
Значение свойства
boolean
Комментарии
type
Возвращает тип фигуры. В настоящее время поддерживаются только следующие фигуры: текстовые поля, геометрические фигуры, группы, рисунки и холсты.
type?: boolean;
Значение свойства
boolean
Комментарии
visible
Указывает, видна ли фигура. Неприменимо к встроенным фигурам.
visible?: boolean;
Значение свойства
boolean
Комментарии
width
Ширина фигуры в точках.
width?: boolean;
Значение свойства
boolean
Комментарии
widthRelative
Процент от ширины фигуры до горизонтального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.
widthRelative?: boolean;
Значение свойства
boolean
Комментарии
Office Add-ins