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

Word.Interfaces.ShapeData interface

  • Ссылка
Пакет:
word

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

Свойства

allowOverlap

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

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

Представляет основной объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.
canvas

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

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

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

Высота фигуры в точках.
heightRelative

Процент от высоты фигуры до вертикального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.
id

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

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

Расстояние в точках от левой стороны фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
leftRelative

Относительное левое положение в процентах от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
lockAspectRatio

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

Имя фигуры.
parentCanvas

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

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

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

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

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

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

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

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

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

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

Расстояние в точках от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной фигуры она вернет 0 и не может быть задана. Для дочерней фигуры на холсте или в группе она находится относительно левого верхнего угла.
topRelative

Относительная верхняя позиция в процентах от верхнего края фигуры до вертикального относительного положения см. Word. RelativeVerticalPosition. Для встроенной или дочерней фигуры она вернет 0 и не может быть задана.
type

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

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

Ширина фигуры в точках.
widthRelative

Процент от ширины фигуры до горизонтального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.

Сведения о свойстве

allowOverlap

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

allowOverlap?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

altTextDescription

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

altTextDescription?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

Процент от высоты фигуры до вертикального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.

heightRelative?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

id

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

id?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

isChild

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

isChild?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

left

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

left?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

leftRelative

Относительное левое положение в процентах от левой части фигуры до горизонтального относительного положения см. Word. RelativeHorizontalPosition. Для встроенной или дочерней фигуры она вернет 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

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

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

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

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?: Word.Interfaces.TextFrameData;

Значение свойства

Word.Interfaces.TextFrameData

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

textWrap

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

textWrap?: Word.Interfaces.ShapeTextWrapData;

Значение свойства

Word.Interfaces.ShapeTextWrapData

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

top

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

top?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

topRelative

Относительная верхняя позиция в процентах от верхнего края фигуры до вертикального относительного положения см. Word. 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

Процент от ширины фигуры до горизонтального относительного размера см. Word. RelativeSize. Для встроенной или дочерней фигуры ее нельзя задать.

widthRelative?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]