Word.Interfaces.ShapeLoadOptions interface
Представляет фигуру в верхнем, нижнем или основном тексте документа. В настоящее время поддерживаются только следующие фигуры: надписи, геометрические фигуры, группы, рисунки и холсты.
Свойства
| $all | Указание |
| allow |
Определяет, может ли заданная фигура перекрывать другие фигуры. |
| alt |
Строка, представляющая замещающий текст, связанный с фигурой. |
| body | Получает |
| canvas | Получает холст, связанный с фигурой. Объект со |
| fill | Возвращает форматирование заливки фигуры. |
| geometric |
Определяет тип геометрической фигуры. Она будет пустой, если это не геометрическая фигура. |
| height | Указывает высоту фигуры в точках. |
| height |
Задает процентное отношение высоты фигуры к относительному размеру фигуры по вертикали (то есть свойство |
| id | Получает целое число, представляющее идентификатор фигуры. |
| is |
Проверьте, является ли эта фигура дочерней фигурой группы или фигуры холста. |
| left | Определяет расстояние в точках от левой стороны фигуры до относительного горизонтального положения (то есть |
| left |
Задает относительное положение слева в процентах от левого края фигуры до относительного горизонтального положения (то есть |
| lock |
Пропорции фигуры заблокированы. |
| name | Указывает имя фигуры. |
| parent |
Получает родительский холст верхнего уровня для этой дочерней фигуры. Она будет иметь значение null, если не является дочерней фигурой холста. |
| parent |
Получает фигуру верхнего уровня родительской группы этой дочерней фигуры. Если эта фигура не является дочерней фигурой группы, она будет пустой. |
| relative |
Определяет относительное горизонтальное положение фигуры. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяГоризонтальнаяПозиция. |
| relative |
Определяет относительный размер фигуры по горизонтали. Использование со свойством |
| relative |
Указывает относительное положение фигуры по вертикали. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяВертикальнаяПозиция. |
| relative |
Определяет относительный размер фигуры по вертикали. Использование со свойством |
| rotation | Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст". |
| shape |
Получает группу фигур, связанную с фигурой. Объект со |
| text |
Получает |
| text |
Возвращает обтекание текстом фигуры. |
| top | Указывает расстояние в точках от верхнего края фигуры до относительного вертикального положения (то есть |
| top |
Задает относительную верхнюю позицию в процентах от верхнего края фигуры до относительной вертикальной позиции (то есть |
| type | Получает тип фигуры. В настоящее время поддерживаются только следующие фигуры: надписи, геометрические фигуры, группы, рисунки и холсты. |
| visible | Указывает, отображается ли фигура. Не применимо к встроенным фигурам. |
| width | Определяет ширину фигуры (в точках). |
| width |
Задает процентное отношение ширины фигуры к относительному размеру по горизонтали (то есть свойство |
Сведения о свойстве
$all
Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.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
Определяет тип геометрической фигуры. Она будет пустой, если это не геометрическая фигура.
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
Получает фигуру верхнего уровня родительской группы этой дочерней фигуры. Если эта фигура не является дочерней фигурой группы, она будет пустой.
parentGroup?: Word.Interfaces.ShapeLoadOptions;Значение свойства
Комментарии
relativeHorizontalPosition
Определяет относительное горизонтальное положение фигуры. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяГоризонтальнаяПозиция.
relativeHorizontalPosition?: boolean;Значение свойства
boolean
Комментарии
relativeHorizontalSize
Определяет относительный размер фигуры по горизонтали. Использование со свойством widthRelative . Для встроенной или дочерней фигуры задать этот параметр невозможно.
relativeHorizontalSize?: boolean;Значение свойства
boolean
Комментарии
relativeVerticalPosition
Указывает относительное положение фигуры по вертикали. Для встроенной фигуры ее задать невозможно. Дополнительные сведения см. в статье Word. ОтносительнаяВертикальнаяПозиция.
relativeVerticalPosition?: boolean;Значение свойства
boolean
Комментарии
relativeVerticalSize
Определяет относительный размер фигуры по вертикали. Использование со свойством heightRelative . Для встроенной или дочерней фигуры задать этот параметр невозможно.
relativeVerticalSize?: boolean;Значение свойства
boolean
Комментарии
rotation
Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст".
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