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