Word.Shape class

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

allowOverlap: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

altTextDescription: string;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly body: Word.Body;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly canvas: Word.Canvas;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

context: RequestContext;

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

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

readonly fill: Word.ShapeFill;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Тип геометрической фигуры фигуры. Он будет иметь значение 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";

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

height: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

heightRelative: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly id: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly isChild: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

left: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

leftRelative: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

lockAspectRatio: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Имя фигуры.

name: string;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly parentCanvas: Word.Shape;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly parentGroup: Word.Shape;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

rotation: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly shapeGroup: Word.ShapeGroup;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly textFrame: Word.TextFrame;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

readonly textWrap: Word.ShapeTextWrap;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

top: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

topRelative: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

visible: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

width: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

widthRelative: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

delete(): void;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

moveHorizontally(distance: number): void;

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

moveVertically(distance: number): void;

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

select(selectMultipleShapes?: boolean): void;

Параметры

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

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

Параметры

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

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

set(properties: Word.Shape): void;

Параметры

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

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

toJSON(): Word.Interfaces.ShapeData;

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

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

track(): Word.Shape;

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

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

untrack(): Word.Shape;

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