GroupShape Class |
Namespace: Aspose.Words.Drawing
The GroupShape type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | GroupShape |
Creates a new group shape.
|
Name | Description | |
---|---|---|
![]() ![]() | AllowOverlap |
Gets or sets a value that specifies whether this shape can overlap other shapes.
(Inherited from ShapeBase.) |
![]() ![]() | AlternativeText |
Defines alternative text to be displayed instead of a graphic.
(Inherited from ShapeBase.) |
![]() ![]() | AnchorLocked |
Specifies whether the shape's anchor is locked.
(Inherited from ShapeBase.) |
![]() ![]() | AspectRatioLocked |
Specifies whether the shape's aspect ratio is locked.
(Inherited from ShapeBase.) |
![]() ![]() | BehindText |
Specifies whether the shape is below or above text.
(Inherited from ShapeBase.) |
![]() ![]() | Bottom |
Gets the position of the bottom edge of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | Bounds |
Gets or sets the location and size of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | BoundsInPoints |
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
(Inherited from ShapeBase.) |
![]() ![]() | BoundsWithEffects |
Gets final extent that this shape object has after applying drawing effects.
Value is measured in points.
(Inherited from ShapeBase.) |
![]() ![]() | CanHaveImage |
Returns true if the shape type allows the shape to have an image.
(Inherited from ShapeBase.) |
![]() ![]() | ChildNodes |
Gets all immediate child nodes of this node.
(Inherited from CompositeNode.) |
![]() ![]() | CoordOrigin |
The coordinates at the top-left corner of the containing block of this shape.
(Inherited from ShapeBase.) |
![]() ![]() | CoordSize |
The width and height of the coordinate space inside the containing block of this shape.
(Inherited from ShapeBase.) |
![]() ![]() | Count |
Gets the number of immediate children of this node.
(Inherited from CompositeNode.) |
![]() ![]() | DistanceBottom |
Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | DistanceLeft |
Returns or sets the distance (in points) between the document text and the left edge of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | DistanceRight |
Returns or sets the distance (in points) between the document text and the right edge of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | DistanceTop |
Returns or sets the distance (in points) between the document text and the top edge of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | Document |
Gets the document to which this node belongs.
(Inherited from Node.) |
![]() ![]() | FirstChild |
Gets the first child of the node.
(Inherited from CompositeNode.) |
![]() ![]() | FlipOrientation |
Switches the orientation of a shape.
(Inherited from ShapeBase.) |
![]() ![]() | Font |
Provides access to the font formatting of this object.
(Inherited from ShapeBase.) |
![]() ![]() | HasChildNodes |
Returns true if this node has any child nodes.
(Inherited from CompositeNode.) |
![]() ![]() | Height |
Gets or sets the height of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | HorizontalAlignment |
Specifies how the shape is positioned horizontally.
(Inherited from ShapeBase.) |
![]() ![]() | HRef |
Gets or sets the full hyperlink address for a shape.
(Inherited from ShapeBase.) |
![]() ![]() | IsComposite |
Returns true as this node can have child nodes.
(Inherited from CompositeNode.) |
![]() ![]() | IsDeleteRevision |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
(Inherited from ShapeBase.) |
![]() ![]() | IsGroup |
Returns true if this is a group shape.
(Inherited from ShapeBase.) |
![]() ![]() | IsHorizontalRule |
Returns true if this shape is a horizontal rule.
(Inherited from ShapeBase.) |
![]() ![]() | IsImage |
Returns true if this shape is an image shape.
(Inherited from ShapeBase.) |
![]() ![]() | IsInline |
A quick way to determine if this shape is positioned inline with text.
(Inherited from ShapeBase.) |
![]() ![]() | IsInsertRevision |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
(Inherited from ShapeBase.) |
![]() ![]() | IsLayoutInCell |
Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.
(Inherited from ShapeBase.) |
![]() ![]() | IsMoveFromRevision |
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
(Inherited from ShapeBase.) |
![]() ![]() | IsMoveToRevision |
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
(Inherited from ShapeBase.) |
![]() ![]() | IsSignatureLine |
Indicates that shape is a SignatureLine.
(Inherited from ShapeBase.) |
![]() ![]() | IsTopLevel |
Returns true if this shape is not a child of a group shape.
(Inherited from ShapeBase.) |
![]() ![]() | IsWordArt |
Returns true if this shape is a WordArt object.
(Inherited from ShapeBase.) |
![]() ![]() | LastChild |
Gets the last child of the node.
(Inherited from CompositeNode.) |
![]() ![]() | Left |
Gets or sets the position of the left edge of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | MarkupLanguage |
Gets MarkupLanguage used for this graphic object.
(Inherited from ShapeBase.) |
![]() ![]() | Name |
Gets or sets the optional shape name.
(Inherited from ShapeBase.) |
![]() ![]() | NextSibling |
Gets the node immediately following this node.
(Inherited from Node.) |
![]() ![]() | NodeType |
Returns GroupShape.
(Overrides NodeNodeType.) |
![]() ![]() | ParentNode |
Gets the immediate parent of this node.
(Inherited from Node.) |
![]() ![]() | ParentParagraph |
Returns the immediate parent paragraph.
(Inherited from ShapeBase.) |
![]() ![]() | PreviousSibling |
Gets the node immediately preceding this node.
(Inherited from Node.) |
![]() ![]() | Range |
Returns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node.) |
![]() ![]() | RelativeHorizontalPosition |
Specifies relative to what the shape is positioned horizontally.
(Inherited from ShapeBase.) |
![]() ![]() | RelativeVerticalPosition |
Specifies relative to what the shape is positioned vertically.
(Inherited from ShapeBase.) |
![]() ![]() | Right |
Gets the position of the right edge of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | Rotation |
Defines the angle (in degrees) that a shape is rotated.
Positive value corresponds to clockwise rotation angle.
(Inherited from ShapeBase.) |
![]() ![]() | ScreenTip |
Defines the text displayed when the mouse pointer moves over the shape.
(Inherited from ShapeBase.) |
![]() ![]() | ShapeType |
Gets the shape type.
(Inherited from ShapeBase.) |
![]() ![]() | SizeInPoints |
Gets the size of the shape in points.
(Inherited from ShapeBase.) |
![]() ![]() | Target |
Gets or sets the target frame for the shape hyperlink.
(Inherited from ShapeBase.) |
![]() ![]() | Title |
Gets or sets the title (caption) of the current shape object.
(Inherited from ShapeBase.) |
![]() ![]() | Top |
Gets or sets the position of the top edge of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | VerticalAlignment |
Specifies how the shape is positioned vertically.
(Inherited from ShapeBase.) |
![]() ![]() | Width |
Gets or sets the width of the containing block of the shape.
(Inherited from ShapeBase.) |
![]() ![]() | WrapSide |
Specifies how the text is wrapped around the shape.
(Inherited from ShapeBase.) |
![]() ![]() | WrapType |
Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.
(Inherited from ShapeBase.) |
![]() ![]() | ZOrder |
Determines the display order of overlapping shapes.
(Inherited from ShapeBase.) |
Name | Description | |
---|---|---|
![]() ![]() | Accept |
Accepts a visitor.
(Overrides NodeAccept(DocumentVisitor).) |
![]() ![]() | AdjustWithEffects |
Adds to the source rectangle values of the effect extent and returns the final rectangle.
(Inherited from ShapeBase.) |
![]() ![]() | AppendChild |
Adds the specified node to the end of the list of child nodes for this node.
(Inherited from CompositeNode.) |
![]() ![]() | Clone | (Inherited from Node.) |
![]() | Equals | (Inherited from Object.) |
![]() ![]() | GetAncestor(Type) |
Gets the first ancestor of the specified object type.
(Inherited from Node.) |
![]() ![]() | GetAncestor(NodeType) |
Gets the first ancestor of the specified NodeType.
(Inherited from Node.) |
![]() ![]() | GetChild |
Returns an Nth child node that matches the specified type.
(Inherited from CompositeNode.) |
![]() ![]() | GetChildNodes |
Returns a live collection of child nodes that match the specified type.
(Inherited from CompositeNode.) |
![]() ![]() | GetEnumerator |
Provides support for the for each style iteration over the child nodes of this node.
(Inherited from CompositeNode.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() ![]() | GetShapeRenderer |
Creates and returns an object that can be used to render this shape into an image.
(Inherited from ShapeBase.) |
![]() ![]() | GetText |
Gets the text of this node and of all its children.
(Inherited from CompositeNode.) |
![]() | GetType | (Inherited from Object.) |
![]() ![]() | IndexOf |
Returns the index of the specified child node in the child node array.
(Inherited from CompositeNode.) |
![]() ![]() | InsertAfter |
Inserts the specified node immediately after the specified reference node.
(Inherited from CompositeNode.) |
![]() ![]() | InsertBefore |
Inserts the specified node immediately before the specified reference node.
(Inherited from CompositeNode.) |
![]() ![]() | LocalToParent |
Converts a value from the local coordinate space into the coordinate space of the parent shape.
(Inherited from ShapeBase.) |
![]() ![]() | NextPreOrder |
Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node.) |
![]() ![]() | PrependChild |
Adds the specified node to the beginning of the list of child nodes for this node.
(Inherited from CompositeNode.) |
![]() ![]() | PreviousPreOrder |
Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node.) |
![]() ![]() | Remove |
Removes itself from the parent.
(Inherited from Node.) |
![]() ![]() | RemoveAllChildren |
Removes all the child nodes of the current node.
(Inherited from CompositeNode.) |
![]() ![]() | RemoveChild |
Removes the specified child node.
(Inherited from CompositeNode.) |
![]() ![]() | RemoveSmartTags |
Removes all SmartTag descendant nodes of the current node.
(Inherited from CompositeNode.) |
![]() ![]() | SelectNodes |
Selects a list of nodes matching the XPath expression.
(Inherited from CompositeNode.) |
![]() ![]() | SelectSingleNode |
Selects the first Node that matches the XPath expression.
(Inherited from CompositeNode.) |
![]() | ToString | (Inherited from Object.) |
![]() ![]() | ToString(SaveFormat) |
Exports the content of the node into a string in the specified format.
(Inherited from Node.) |
![]() ![]() | ToString(SaveOptions) |
Exports the content of the node into a string using the specified save options.
(Inherited from Node.) |
A GroupShape is a composite node and can have Shape and GroupShape nodes as children.
Each GroupShape defines a new coordinate system for its child shapes. The coordinate system is defined using the CoordSize and CoordOrigin properties.
public void GroupOfShapes() { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If you need to create "NonPrimitive" shapes, like SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped, // TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, DiagonalCornersRounded // please use DocumentBuilder.InsertShape methods 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); ShapeInfoPrinter printer = new ShapeInfoPrinter(); group.Accept(printer); Console.WriteLine(printer.GetText()); } /// <summary> /// Visitor that prints shape group contents information to the console. /// </summary> public class ShapeInfoPrinter : DocumentVisitor { public ShapeInfoPrinter() { 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.Color); return VisitorAction.Continue; } public override VisitorAction VisitShapeEnd(Shape shape) { mBuilder.AppendLine("\tEnd of shape"); return VisitorAction.Continue; } private readonly StringBuilder mBuilder; }