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


Word.Shape class

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

Extends

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Свойства

allowOverlap

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

altTextDescription

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

body

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

canvas

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

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

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

Методы

delete()

Удаляет фигуру и ее содержимое.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

moveHorizontally(distance)

Перемещает фигуру по горизонтали на количество точек.

moveVertically(distance)

Перемещает фигуру по вертикали на количество точек.

scaleHeight(scaleFactor, scaleType, scaleFrom)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleHeight(scaleFactor, scaleTypeString, scaleFromString)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleWidth(scaleFactor, scaleType, scaleFrom)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleWidth(scaleFactor, scaleTypeString, scaleFromString)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

select(selectMultipleShapes)

Выбирает фигуру.

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Shape объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ShapeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

allowOverlap

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

allowOverlap: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

altTextDescription

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

altTextDescription: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

body

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

readonly body: Word.Body;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

canvas

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

readonly canvas: Word.Canvas;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

fill

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

readonly fill: Word.ShapeFill;

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

Комментарии

[ Набор 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

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

readonly id: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

isChild

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

readonly 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, если он не является дочерней фигурой холста.

readonly parentCanvas: Word.Shape;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

parentGroup

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

readonly parentGroup: Word.Shape;

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

Комментарии

[ Набор 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.

readonly shapeGroup: Word.ShapeGroup;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

textFrame

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

readonly textFrame: Word.TextFrame;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

textWrap

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

readonly textWrap: Word.ShapeTextWrap;

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

Комментарии

[ Набор 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

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

readonly 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 ]

Сведения о методе

delete()

Удаляет фигуру и ее содержимое.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;

Параметры

options
Word.Interfaces.ShapeLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.Shape;

Параметры

propertyNames

string | string[]

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

Возвращаемое значение

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Shape;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

moveHorizontally(distance)

Перемещает фигуру по горизонтали на количество точек.

moveHorizontally(distance: number): void;

Параметры

distance

number

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

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

moveVertically(distance)

Перемещает фигуру по вертикали на количество точек.

moveVertically(distance: number): void;

Параметры

distance

number

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

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleType, scaleFrom)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Параметры

scaleFactor

number

Задает отношение между высотой фигуры после ее изменения и текущей или исходной высотой.

scaleType
Word.ShapeScaleType

Указывает, масштабируется ли фигура относительно ее исходного или текущего размера. Исходный параметр масштабирования размера работает только для изображений.

scaleFrom
Word.ShapeScaleFrom

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, это означает, что левый верхний угол фигуры сохраняет свое положение.

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleTypeString, scaleFromString)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Параметры

scaleFactor

number

Задает отношение между высотой фигуры после ее изменения и текущей или исходной высотой.

scaleTypeString

"CurrentSize" | "OriginalSize"

Указывает, масштабируется ли фигура относительно ее исходного или текущего размера. Исходный параметр масштабирования размера работает только для изображений.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, это означает, что левый верхний угол фигуры сохраняет свое положение.

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleType, scaleFrom)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Параметры

scaleFactor

number

Задает отношение между шириной фигуры после ее изменения и текущей или исходной ширины.

scaleType
Word.ShapeScaleType

Указывает, масштабируется ли фигура относительно ее исходного или текущего размера. Исходный параметр масштабирования размера работает только для изображений.

scaleFrom
Word.ShapeScaleFrom

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, это означает, что левый верхний угол фигуры сохраняет свое положение.

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleTypeString, scaleFromString)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Параметры

scaleFactor

number

Задает отношение между шириной фигуры после ее изменения и текущей или исходной ширины.

scaleTypeString

"CurrentSize" | "OriginalSize"

Указывает, масштабируется ли фигура относительно ее исходного или текущего размера. Исходный параметр масштабирования размера работает только для изображений.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, это означает, что левый верхний угол фигуры сохраняет свое положение.

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

select(selectMultipleShapes)

Выбирает фигуру.

select(selectMultipleShapes?: boolean): void;

Параметры

selectMultipleShapes

boolean

Необязательный параметр. Выбор нескольких фигур с плавающей точкой. Значение по умолчанию — false.

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Word.Interfaces.ShapeUpdateData

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

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.Shape): void;

Параметры

properties
Word.Shape

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Shape объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ShapeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.ShapeData;

Возвращаемое значение

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.Shape;

Возвращаемое значение

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.Shape;

Возвращаемое значение