Word.Interfaces.ShapeData interface

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

Комментарии

Используется

Свойства

allowOverlap

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

altTextDescription

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

body

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

canvas

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

fill

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

geometricShapeType

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

height

Указывает высоту фигуры в точках.

heightRelative

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

id

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

isChild

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

left

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

leftRelative

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

lockAspectRatio

Пропорции фигуры заблокированы.

name

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

parentCanvas

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

parentGroup

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

relativeHorizontalPosition

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

relativeHorizontalSize

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

relativeVerticalPosition

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

relativeVerticalSize

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

rotation

Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст".

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;

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

Комментарии

Набор API: WordApiDesktop 1.2

canvas

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

canvas?: Word.Interfaces.CanvasData;

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

Комментарии

Набор API: WordApiDesktop 1.2

fill

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

fill?: Word.Interfaces.ShapeFillData;

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

Комментарии

Набор API: WordApiDesktop 1.2

geometricShapeType

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

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;

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

Комментарии

Набор API: WordApiDesktop 1.2

parentGroup

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

parentGroup?: Word.Interfaces.ShapeData;

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

Комментарии

Набор API: WordApiDesktop 1.2

relativeHorizontalPosition

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

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?: 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

Угол поворота фигуры (в градусах). Неприменимо к фигуре "Холст".

rotation?: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.2

shapeGroup

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

shapeGroup?: Word.Interfaces.ShapeGroupData;

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

Комментарии

Набор API: WordApiDesktop 1.2

textFrame

Получает TextFrame объект фигуры.

textFrame?: Word.Interfaces.TextFrameData;

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

Комментарии

Набор API: WordApiDesktop 1.2

textWrap

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

textWrap?: 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