Поделиться через

Word.Interfaces.ShapeData interface

Пакет:
word

Интерфейс, описывающий данные, возвращаемые путем вызова shape.toJSON().

Свойства

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 свойства). Для встроенной или дочерней фигуры ее нельзя задать.

Подробнее

allowOverlap

Указывает, может ли данная фигура перекрывать другие фигуры.

allowOverlap?: boolean;

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

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

altTextDescription

Задает строку, представляющую альтернативный текст, связанный с фигурой.

altTextDescription?: string;

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

string

Замечания

[ Набор API: WordApiDesktop 1.2 ]

body

Body Возвращает объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.

body?: Word.Interfaces.BodyData;

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

Word.Interfaces.BodyData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

canvas

Возвращает холст, связанный с фигурой. Объект со свойством , для свойства isNullObject , true возвращается, если тип фигуры не canvasимеет значения . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

canvas?: Word.Interfaces.CanvasData;

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

Word.Interfaces.CanvasData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

fill

Возвращает форматирование заливки фигуры.

fill?: Word.Interfaces.ShapeFillData;

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

Word.Interfaces.ShapeFillData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

geometricShapeType

Указывает тип геометрической фигуры. Он будет иметь значение NULL, если не является геометрической фигурой.

geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

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

Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

height

Задает высоту фигуры (в точках).

height?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

heightRelative

Указывает процент высоты фигуры относительного вертикального размера (то есть relativeVerticalSize свойства). Для встроенной или дочерней фигуры ее нельзя задать.

heightRelative?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

id

Возвращает целое число, представляющее идентификатор фигуры.

id?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

isChild

Проверьте, является ли эта фигура дочерним элементом фигуры группы или фигуры холста.

isChild?: boolean;

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

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

left

Указывает расстояние (в точках) от левой стороны фигуры до относительного горизонтального положения (то есть relativeHorizontalPosition свойства). Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.

left?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

leftRelative

Задает относительное левое положение в процентах от левой части фигуры до относительной горизонтальной позиции (т. е relativeHorizontalalPosition . свойства). Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.

leftRelative?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

lockAspectRatio

Указывает, заблокировано ли пропорции этой фигуры.

lockAspectRatio?: boolean;

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

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

name

Указывает имя фигуры.

name?: string;

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

string

Замечания

[ Набор API: WordApiDesktop 1.2 ]

parentCanvas

Возвращает форму родительского холста верхнего уровня для этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой холста.

parentCanvas?: Word.Interfaces.ShapeData;

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

Word.Interfaces.ShapeData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

parentGroup

Возвращает фигуру родительской группы верхнего уровня этой дочерней фигуры. Он будет иметь значение NULL, если он не является дочерней фигурой группы.

parentGroup?: Word.Interfaces.ShapeData;

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

Word.Interfaces.ShapeData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeHorizontalPosition

Задает относительное горизонтальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeHorizontalPosition.

relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

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

Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeHorizontalSize

Задает относительный размер фигуры по горизонтали. Используйте со свойством widthRelative . Для встроенной или дочерней фигуры ее нельзя задать.

relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

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

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeVerticalPosition

Задает относительное вертикальное положение фигуры. Для встроенной фигуры ее нельзя задать. Дополнительные сведения см. в разделе Word. RelativeVerticalPosition.

relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

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

Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

relativeVerticalSize

Задает относительный вертикальный размер фигуры. Используйте со свойством heightRelative . Для встроенной или дочерней фигуры ее нельзя задать.

relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

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

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

rotation

Задает поворот фигуры в градусах. Неприменимо к фигуре Canvas.

rotation?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

shapeGroup

Возвращает группу фигур, связанную с фигурой. Объект со свойством , для свойства isNullObject , true возвращается, если тип фигуры не groupShapeимеет значения . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

shapeGroup?: Word.Interfaces.ShapeGroupData;

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

Word.Interfaces.ShapeGroupData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

textFrame

TextFrame Возвращает объект фигуры.

textFrame?: Word.Interfaces.TextFrameData;

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

Word.Interfaces.TextFrameData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

textWrap

Возвращает форматирование фигуры в оболочке текста.

textWrap?: Word.Interfaces.ShapeTextWrapData;

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

Word.Interfaces.ShapeTextWrapData

Замечания

[ Набор API: WordApiDesktop 1.2 ]

top

Указывает расстояние (в точках) от верхнего края фигуры до относительного вертикального положения (то есть relativeVerticalPosition свойства). Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.

top?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

topRelative

Задает относительное верхнее положение в процентах от верхнего края фигуры до относительной вертикальной позиции (то есть relativeVerticalPosition свойства). Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.

topRelative?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

type

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

type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";

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

Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"

Замечания

[ Набор API: WordApiDesktop 1.2 ]

visible

Указывает, видна ли фигура. Неприменимо к встроенным фигурам.

visible?: boolean;

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

boolean

Замечания

[ Набор API: WordApiDesktop 1.2 ]

width

Задает ширину фигуры (в точках).

width?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]

widthRelative

Указывает процент ширины фигуры относительного горизонтального размера (то есть relativeHorizontalSize свойства). Для встроенной или дочерней фигуры ее нельзя задать.

widthRelative?: number;

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

number

Замечания

[ Набор API: WordApiDesktop 1.2 ]