Shape

概述

Shape 是 Aspose.Words FOSS 用于 .NET 的一个类。继承自：ShapeBase、ITextBox、IStrokable。

表示绘图层中的对象，例如 AutoShape、文本框、自由形状、OLE 对象、ActiveX 控件或图片。

此类提供了 29 个用于在 .NET 程序中处理 Shape 对象的方法。可用的方法包括：Accept、AcceptEnd、AcceptStart、AdjustWithEffects、AppendChild、Clone、CreateNavigator、GetAncestor、GetAncestorOf、GetChild、GetChildNodes、GetEnumerator，以及另外 17 个方法。安装 Aspose.Words FOSS for .NET 包后，所有公共成员均可被任何 .NET 应用程序访问。属性：Adjustments、AllowOverlap、AlternativeText、AnchorLocked、AspectRatioLocked、BehindText，以及另外 93 项。

属性

名称	类型	访问	描述
`NodeType`	`NodeType`	读取	返回 Shape。
`StoryType`	`StoryType`	读取	返回 Textbox。
`ExtrusionEnabled`	`bool`	读取	如果启用了挤出效果，则返回 true。
`ShadowEnabled`	`bool`	读取	如果启用了阴影效果，则返回 true。
`Stroke`	`Stroke`	读取	为形状定义 stroke。
`Stroked`	`bool`	读写	定义路径是否会被描边。
`StrokeWeight`	`double`	读写	定义用于在点单位下描绘形状路径的笔刷粗细。
`StrokeColor`	`Color`	读写	定义描边的颜色。
`Filled`	`bool`	读写	确定形状的闭合路径是否会被填充。
`FillColor`	`Color`	读写	定义用于填充形状闭合路径的画笔颜色。
`HasImage`	`bool`	读取	如果形状包含图像字节或链接到图像，则返回 true。
`ImageData`	`ImageData`	读取	提供对形状图像的访问。
`OleFormat`	`OleFormat`	读取	提供对形状的 OLE 数据的访问。
`TextBox`	`TextBox`	读取	定义指定文本在形状中如何显示的属性。
`TextPath`	`TextPath`	读取	定义文本路径的文本（WordArt 对象）。
`FirstParagraph`	`Paragraph`	读取	获取形状中的第一段落。
`LastParagraph`	`Paragraph`	读取	获取形状中的最后一个段落。
`HorizontalRuleFormat`	`HorizontalRuleFormat`	读取	提供对水平线形状属性的访问。
`Adjustments`	`AdjustmentCollection`	读取	提供对形状调整原始值的访问。
`SignatureLine`	`SignatureLine`	读取	如果形状是签名行，则获取 SignatureLine 对象。
`HasChart`	`bool`	读取	如果此 Shape 具有 Chart，则返回 true。
`HasSmartArt`	`bool`	读取	如果此 Shape 具有 SmartArt 对象，则返回 true。
`Chart`	`Chart`	读取	如果此 shape 具有 Chart，则提供对图表属性的访问。
`Fill`	`Fill`	读取	获取形状的填充格式。
`ShadowFormat`	`ShadowFormat`	读取	获取形状的阴影格式。
`Glow`	`GlowFormat`	读取	获取形状的发光格式。
`Reflection`	`ReflectionFormat`	读取	获取形状的反射格式。
`SoftEdge`	`SoftEdgeFormat`	读取	获取形状的柔和边缘格式。
`ScreenTip`	`string`	读写	定义当鼠标指针移动到形状上方时显示的文本。
`HRef`	`string`	读写	获取或设置形状的完整超链接地址。
`Target`	`string`	读写	获取或设置形状超链接的目标框架。
`AlternativeText`	`string`	读写	定义在图形无法显示时显示的替代文本。
`IsDecorative`	`bool`	读写	获取或设置指示该形状在文档中是否为装饰性的标志。
`Title`	`string`	读写	获取或设置当前形状对象的标题（说明）。
`Name`	`string`	读写	获取或设置可选的形状名称。
`IsInsertRevision`	`bool`	读取	获取是否插入修订。
`IsDeleteRevision`	`bool`	读取	获取 is delete revision。
`IsMoveFromRevision`	`bool`	读取	获取来自修订的 `isMove`。
`IsMoveToRevision`	`bool`	读取	获取 is move to revision。
`IsTopLevel`	`bool`	读取	如果此形状不是组形状的子形状，则返回 true。
`IsGroup`	`bool`	读取	如果这是组形状，则返回 true。
`IsImage`	`bool`	读取	如果此形状是图像形状，则返回 true。
`IsHorizontalRule`	`bool`	读取	如果此形状是水平分隔线，则返回 true。
`IsWordArt`	`bool`	读取	如果此形状是一个 WordArt 对象，则返回 true。
`CanHaveImage`	`bool`	读取	如果形状类型允许该形状拥有图像，则返回 true。
`AnchorLocked`	`bool`	读写	指定形状的锚点是否被锁定。
`AspectRatioLocked`	`bool`	读写	指定形状的宽高比是否被锁定。
`AllowOverlap`	`bool`	读写	获取或设置一个值，以指定此形状是否可以覆盖其他形状。
`BehindText`	`bool`	读写	指定形状位于文本的下方还是上方。
`IsInline`	`bool`	读取	快速判断此形状是否与文本内联定位。
`Left`	`double`	读写	获取或设置形状的包含块左边缘的位置。
`Top`	`double`	读写	获取或设置形状所在包含块的顶部边缘位置。
`Right`	`double`	读取	获取形状所在包含块的右边缘位置。
`Bottom`	`double`	读取	获取形状所在包含块的底部边缘位置。
`Width`	`double`	读写	获取或设置形状的包含块的宽度。
`Height`	`double`	读写	获取或设置形状所在容器块的高度。
`DistanceTop`	`double`	读写	返回或设置文档文本与形状上边缘之间的距离（单位为点）。
`DistanceBottom`	`double`	读写	返回或设置文档文本与形状下边缘之间的距离（单位为点）。
`DistanceLeft`	`double`	读写	返回或设置文档文本与形状左边缘之间的距离（以点为单位）。
`DistanceRight`	`double`	读写	返回或设置文档文本与形状右边缘之间的距离（以点为单位）。
`Rotation`	`double`	读写	定义形状旋转的角度（以度为单位）。
`ZOrder`	`int`	读写	确定重叠形状的显示顺序。
`ParentParagraph`	`Paragraph`	读取	返回最近的父段落。
`Bounds`	`RectangleF`	读写	获取或设置形状的包含块的位置和大小。
`BoundsInPoints`	`RectangleF`	读取	获取形状的包含块相对于最顶层形状锚点的位置信息和尺寸（单位为点）。
`BoundsWithEffects`	`RectangleF`	读取	获取此形状对象在应用绘图效果后得到的最终范围。
`ShapeType`	`ShapeType`	读取	获取形状类型。
`MarkupLanguage`	`ShapeMarkupLanguage`	读取	获取用于此图形对象的 MarkupLanguage。
`SizeInPoints`	`SizeF`	读取	获取形状的大小（以点为单位）。
`FlipOrientation`	`FlipOrientation`	读写	切换形状的方向。
`RelativeHorizontalPosition`	`RelativeHorizontalPosition`	读写	指定形状在水平位置上相对于何物进行定位。
`RelativeVerticalPosition`	`RelativeVerticalPosition`	读写	指定形状在垂直位置上相对于何物进行定位。
`RelativeHorizontalSize`	`RelativeHorizontalSize`	读写	获取或设置形状在水平方向的相对大小值。
`RelativeVerticalSize`	`RelativeVerticalSize`	读写	获取或设置形状在垂直方向上的相对大小值。
`LeftRelative`	`float`	读写	获取或设置表示形状相对左侧位置的百分比值。
`TopRelative`	`float`	读写	获取或设置表示形状相对顶部位置的百分比值。
`HeightRelative`	`float`	读写	获取或设置表示形状相对高度的百分比值。
`WidthRelative`	`float`	读写	获取或设置表示形状相对宽度的百分比值。
`HorizontalAlignment`	`HorizontalAlignment`	读写	指定形状在水平方向上的定位方式。
`VerticalAlignment`	`VerticalAlignment`	读写	指定形状在垂直方向上的定位方式。
`WrapType`	`WrapType`	读写	定义形状是内联还是浮动。
`WrapSide`	`WrapSide`	读写	指定文本如何环绕形状。
`CoordOrigin`	`Point`	读写	该形状的包含块左上角的坐标。
`CoordSize`	`Size`	读写	此形状的包含块内部坐标空间的宽度和高度。
`Font`	`Font`	读取	提供对该对象字体格式的访问。
`IsSignatureLine`	`bool`	读取	指示 shape 是一个 SignatureLine。
`IsLayoutInCell`	`bool`	读写	获取或设置一个标志，指示形状是显示在表格内部还是外部。
`Hidden`	`bool`	读写	获取或设置一个布尔值，指示形状是否可见。
`IsComposite`	`bool`	读取	返回 true，因为此节点可以拥有子节点。
`HasChildNodes`	`bool`	读取	如果此节点有任何子节点，则返回 true。
`FirstChild`	`Node`	读取	获取节点的第一个子节点。
`LastChild`	`Node`	读取	获取节点的最后一个子节点。
`Count`	`int`	读取	获取此节点的直接子节点数量。
`ParentNode`	`CompositeNode`	读取	获取此节点的直接父节点。
`Document`	`DocumentBase`	读取	获取此节点所属的文档。
`PreviousSibling`	`Node`	读取	获取紧接在此节点之前的节点。
`NextSibling`	`Node`	读取	获取紧随此节点的节点。
`Range`	`Range`	读取	返回一个 Range 对象，表示文档中包含在此节点中的部分。
`CustomNodeId`	`int`	读写	指定自定义节点标识符。

方法

签名	描述
`Shape(doc: DocumentBase, shapeType: ShapeType)`	创建一个新的 shape 对象。
`Accept(visitor: DocumentVisitor)`	调用 VisitShapeStart，然后对 shape 的所有子节点调用 Accept，最后调用 VisitShapeEnd。
`AcceptStart(visitor: DocumentVisitor)`	接受访问者以访问形状的起始点。
`AcceptEnd(visitor: DocumentVisitor)`	接受访问者以访问形状的终止点。
`LocalToParent(value: PointF)`	将值从局部坐标空间转换为父形状的坐标空间。
`AdjustWithEffects(source: RectangleF)`	将效果范围的值添加到源矩形中，并返回最终矩形。
`GetText()`	获取此节点及其所有子节点的文本。
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	返回匹配指定类型的子节点集合。
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	返回匹配指定类型的第 N 个子节点。
`SelectNodes(xpath: string)`	选择匹配 XPath 表达式的节点列表。
`SelectSingleNode(xpath: string)`	选择匹配 XPath 表达式的第一个节点。
`GetEnumerator()`	提供对该节点子节点的 for each 风格迭代的支持。
`AppendChild(newChild: T)`	将指定的节点添加到该节点子节点列表的末尾。
`PrependChild(newChild: T)`	将指定的节点添加到该节点子节点列表的开头。
`InsertAfter(newChild: T, refChild: Node)`	将指定节点立即插入到指定的参考节点之后。
`InsertBefore(newChild: T, refChild: Node)`	将指定节点立即插入到指定参考节点之前。
`RemoveChild(oldChild: T)`	删除指定的子节点。
`RemoveAllChildren()`	删除当前节点的所有子节点。
`RemoveSmartTags()`	删除当前节点的所有 SmartTag 后代节点。
`IndexOf(child: Node)`	返回指定子节点在子节点数组中的索引。
`CreateNavigator()`	创建一个可用于遍历和读取节点的导航器。
`Clone(isCloneChildren: bool)`	当节点克隆是另一个（通常是复合）节点克隆过程的一部分时，您应该使用 Clone(bool, INodeCloningListener) 重载。
`GetAncestor(ancestorType: Type)`	获取指定对象类型的第一个祖先。
`GetAncestorOf()`	在此 Shape 实例上调用 GetAncestorOf。
`Remove()`	从父节点中移除自身。
`NextPreOrder(rootNode: Node)`	根据前序遍历算法获取下一个节点。
`PreviousPreOrder(rootNode: Node)`	根据前序遍历算法获取上一个节点。
`ToString(saveFormat: SaveFormat)`	将节点的内容导出为指定格式的字符串。
`NodeTypeToString(nodeType: NodeType)`	一个将节点类型枚举值转换为用户友好字符串的实用方法。

另请参阅

Aspose.Words for .NET — Enterprise API Reference