GroupShape

GroupShape class

代表文档中的一组形状。

要了解更多信息，请访问如何在 Word 文档中添加组形状文档文章。

public class GroupShape : ShapeBase

构造函数

姓名描述
GroupShape(DocumentBase)创建一个新的组形状。

特性

姓名描述
AllowOverlap { get; set; }获取或设置一个值，指定此形状是否可以与其他形状重叠。
AlternativeText { get; set; }定义要显示的替代图形的文本。
AnchorLocked { get; set; }指定形状的锚点是否被锁定。
AspectRatioLocked { get; set; }指定形状的纵横比是否被锁定。
BehindText { get; set; }指定形状位于文本下方还是上方。
Bottom { get; }获取形状包含块底边的位置。
Bounds { get; set; }获取或设置形状包含块的位置和大小。
BoundsInPoints { get; }获取形状包含块的位置和大小（以点为单位），相对于最顶层形状的锚点。
BoundsWithEffects { get; }获取此形状对象应用绘图效果后的最终范围。 值以点为单位。
CanHaveImage { get; }返回真的如果形状类型允许形状具有图像。
CoordOrigin { get; set; }此形状包含块的左上角坐标。
CoordSize { get; set; }此形状的包含块内的坐标空间的宽度和高度。
Count { get; }获取此节点的直属子节点的数量。
CustomNodeId { get; set; }指定自定义节点标识符。
DistanceBottom { get; set; }返回或设置文档文本和形状底边之间的距离（以点为单位）。
DistanceLeft { get; set; }返回或设置文档文本和形状左边缘之间的距离（以点为单位）。
DistanceRight { get; set; }返回或设置文档文本和形状右边缘之间的距离（以点为单位）。
DistanceTop { get; set; }返回或设置文档文本和形状顶部边缘之间的距离（以点为单位）。
virtual Document { get; }获取此节点所属的文档。
Fill { get; }获取形状的填充格式。
FirstChild { get; }获取节点的第一个子节点。
FlipOrientation { get; set; }切换形状的方向。
Font { get; }提供对此对象的字体格式的访问。
Glow { get; }获取形状的发光格式。
HasChildNodes { get; }返回真的如果此节点有任何子节点。
Height { get; set; }获取或设置形状包含块的高度。
HeightRelative { get; set; }获取或设置表示形状相对高度百分比的值。
Hidden { get; set; }获取或设置一个布尔值，指示形状是否可见。
HorizontalAlignment { get; set; }指定形状的水平定位方式。
HRef { get; set; }获取或设置形状的完整超链接地址。
override IsComposite { get; }返回真的因为这个节点可以有子节点。
IsDecorative { get; set; }获取或设置指定形状在文档中是否具有装饰性的标志。
IsDeleteRevision { get; }如果在启用更改跟踪的情况下在 Microsoft Word 中删除了此对象，则返回 true。
IsGroup { get; }返回真的如果这是一个组形状。
IsHorizontalRule { get; }返回真的如果此形状是水平规则。
IsImage { get; }返回真的如果此形状是图像形状。
IsInline { get; }快速确定此形状是否与文本对齐。
IsInsertRevision { get; }如果在启用更改跟踪的情况下将此对象插入 Microsoft Word，则返回 true。
IsLayoutInCell { get; set; }获取或设置一个标志，指示形状是显示在表格内部还是外部。
IsMoveFromRevision { get; }返回真的如果在启用更改跟踪的情况下在 Microsoft Word 中移动（删除）此对象。
IsMoveToRevision { get; }返回真的如果在启用更改跟踪的情况下在 Microsoft Word 中移动（插入）此对象。
IsSignatureLine { get; }表示形状是SignatureLine.
IsTopLevel { get; }返回真的如果此形状不是组形状的子形状。
IsWordArt { get; }返回真的如果此形状是艺术字对象。
LastChild { get; }获取节点的最后一个子节点。
Left { get; set; }获取或设置形状包含块左边缘的位置。
LeftRelative { get; set; }获取或设置表示形状相对左侧位置的百分比值。
MarkupLanguage { get; }获取此图形对象使用的标记语言。
Name { get; set; }获取或设置可选形状名称。
NextSibling { get; }获取紧随此节点之后的节点。
override NodeType { get; }返回GroupShape.
ParentNode { get; }获取此节点的直接父节点。
ParentParagraph { get; }返回直接父段落。
PreviousSibling { get; }获取此节点前一个节点。
Range { get; }返回Range表示此节点中包含的文档部分的对象。
Reflection { get; }获取形状的反射格式。
RelativeHorizontalPosition { get; set; }指定形状相对于水平方向的位置。
RelativeHorizontalSize { get; set; }获取或设置形状在水平方向上的相对大小值。
RelativeVerticalPosition { get; set; }指定形状的垂直定位。
RelativeVerticalSize { get; set; }获取或设置形状在垂直方向上的相对大小值。
Right { get; }获取形状包含块右边缘的位置。
Rotation { get; set; }定义形状旋转的角度（以度为单位）。 正值对应顺时针旋转角度。
ScreenTip { get; set; }定义鼠标指针移到形状上时显示的文本。
ShadowFormat { get; }获取形状的阴影格式。
ShapeType { get; }获取形状类型。
SizeInPoints { get; }获取形状的大小（以点为单位）。
SoftEdge { get; }获取形状的软边缘格式。
Target { get; set; }获取或设置形状超链接的目标框架。
Title { get; set; }获取或设置当前形状对象的标题（标题）。
Top { get; set; }获取或设置形状包含块的顶边位置。
TopRelative { get; set; }获取或设置表示形状相对顶部位置的百分比值。
VerticalAlignment { get; set; }指定形状的垂直定位方式。
Width { get; set; }获取或设置形状包含块的宽度。
WidthRelative { get; set; }获取或设置表示形状相对宽度百分比的值。
WrapSide { get; set; }指定文本如何环绕形状。
WrapType { get; set; }定义形状是内联的还是浮动的。对于浮动形状，定义文本环绕形状的环绕模式。
ZOrder { get; set; }确定重叠形状的显示顺序。

方法

姓名描述
override Accept(DocumentVisitor)接受访客。
override AcceptEnd(DocumentVisitor)接受访客访问 GroupShape 的末尾。
override AcceptStart(DocumentVisitor)接受访客访问 GroupShape 的起点。
AdjustWithEffects(RectangleF)将效果范围的源矩形值添加到并返回最终矩形。
AppendChild<T>(T)将指定节点添加到此节点的子节点列表的末尾。
Clone(bool)创建节点的副本。
CreateNavigator()创建可用于遍历和读取节点的导航器。
GetAncestor(NodeType)获取指定的第一个祖先NodeType.
GetAncestor(Type)获取指定对象类型的第一个祖先。
GetChild(NodeType, int, bool)返回与指定类型匹配的第 N 个子节点。
GetChildNodes(NodeType, bool)返回与指定类型匹配的子节点的实时集合。
GetEnumerator()为该节点的子节点提供对每个样式迭代的支持。
GetShapeRenderer()创建并返回可用于将此形状渲染为图像的对象。
override GetText()获取此节点及其所有子节点的文本。
IndexOf(Node)返回子节点数组中指定子节点的索引。
InsertAfter<T>(T, Node)在指定的参考节点后立即插入指定的节点。
InsertBefore<T>(T, Node)在指定的参考节点之前立即插入指定的节点。
LocalToParent(PointF)将值从本地坐标空间转换为父形状的坐标空间。
NextPreOrder(Node)根据前序树遍历算法获取下一个节点。
PrependChild<T>(T)将指定节点添加到此节点的子节点列表的开头。
PreviousPreOrder(Node)根据前序树遍历算法获取前一个节点。
Remove()将自身从父级中移除。
RemoveAllChildren()删除当前节点的所有子节点。
RemoveChild<T>(T)删除指定的子节点。
RemoveSmartTags()删除所有SmartTag当前节点的后代节点。
SelectNodes(string)选择与 XPath 表达式匹配的节点列表。
SelectSingleNode(string)选择第一个Node与 XPath 表达式匹配。
ToString(SaveFormat)将节点的内容导出为指定格式的字符串。
ToString(SaveOptions)使用指定的保存选项将节点内容导出为字符串。

评论

一个GroupShape是一个复合节点，可以有Shapeand GroupShape节点作为子节点。

每个GroupShape为其子形状定义一个新的坐标系。 坐标系使用CoordSize和 CoordOrigin特性。

例子

展示如何创建一组形状，并使用文档访问器打印其内容。

public void GroupOfShapes()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // 如果需要创建“非原始”形状，例如 SingleCornerSnipped、TopCornersSnipped、DiagonalCornersSnipped，
    // 顶角一个圆角一个截角、单角圆角、顶角圆角、对角角圆角
    // 请使用 DocumentBuilder.InsertShape 方法。
    Shape balloon = new Shape(doc, ShapeType.Balloon)
    {
        Width = 200,
        Height = 200,
        Stroke = { Color = Color.Red }
    };

    Shape cube = new Shape(doc, ShapeType.Cube)
    {
        Width = 100,
        Height = 100,
        Stroke = { Color = Color.Blue }
    };

    GroupShape group = new GroupShape(doc);
    group.AppendChild(balloon);
    group.AppendChild(cube);

    Assert.True(group.IsGroup);

    builder.InsertNode(group);

    ShapeGroupPrinter printer = new ShapeGroupPrinter();
    group.Accept(printer);

    Console.WriteLine(printer.GetText());
}

/// <summary>
/// 将访问过的形状组的内容打印到控制台。
/// </summary>
public class ShapeGroupPrinter : DocumentVisitor
{
    public ShapeGroupPrinter()
    {
        mBuilder = new StringBuilder();
    }

    public string GetText()
    {
        return mBuilder.ToString();
    }

    public override VisitorAction VisitGroupShapeStart(GroupShape groupShape)
    {
        mBuilder.AppendLine("Shape group started:");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitGroupShapeEnd(GroupShape groupShape)
    {
        mBuilder.AppendLine("End of shape group");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitShapeStart(Shape shape)
    {
        mBuilder.AppendLine("\tShape - " + shape.ShapeType + ":");
        mBuilder.AppendLine("\t\tWidth: " + shape.Width);
        mBuilder.AppendLine("\t\tHeight: " + shape.Height);
        mBuilder.AppendLine("\t\tStroke color: " + shape.Stroke.Color);
        mBuilder.AppendLine("\t\tFill color: " + shape.Fill.ForeColor);
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitShapeEnd(Shape shape)
    {
        mBuilder.AppendLine("\tEnd of shape");
        return VisitorAction.Continue;
    }

    private readonly StringBuilder mBuilder;
}

也可以看看

GradientVariant Enum HorizontalAlignment Enum