Shape.GluedShapes Method (Visio)
Returns an array that contains the identifiers of the shapes that are glued to a shape.
Version Information
Version Added: Visio 2010
Syntax
expression .GluedShapes(Flags, CategoryFilter, pOtherConnectedShape)
expression A variable that represents a Shape object.
Parameters
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
Flags |
Required |
The dimensionality and directionality of the connection points of the shapes to return. |
|
CategoryFilter |
Required |
String |
The category of shapes to return. See Remarks for more information |
pOtherConnectedShape |
Optional |
Shape |
Additional shape to which returned shapes must also be glued. |
Return Value
Long()
Remarks
Flags must be one of the following VisGluedShapesFlags constants.
Constant |
Value |
Description |
|---|---|---|
visGluedShapesAll1D |
0 |
Return all 1-D shapes that are glued to this shape. |
visGluedShapesIncoming1D |
1 |
Return 1-D shapes whose end points are glued to this shape. |
visGluedShapesOutgoing1D |
2 |
Return 1-D shapes whose begin points are glued to this shape. |
visGluedShapesAll2D |
3 |
Return all 2-D shapes that are glued to this shape and all 2-D shapes to which this shape is glued. |
visGluedShapesIncoming2D |
4 |
If the source object is a 1-D shape, return the 2-D shape to which the begin point is glued. If the source object is a 2-D shape, return the 2-D shapes that are glued to this shape. |
visGluedShapesOutgoing2D |
5 |
If the source object is a 1-D shape, return the 2-D shape to which the end point is glued. If the source object is a 2-D shape, return the 2-D shapes to which this shape is glued. |
Categories are user-defined strings that you can use to categorize shapes and thereby to restrict membership in a container. You can define categories in the User.msvShapeCategories cell in the ShapeSheet for a shape. You can define multiple categories for a shape by separating those categories with semi-colons.
Connection points with dual directionality (both inward and outward) are identified as incoming or outgoing based on the way that they are used in a particular connection.
The GluedShapes method fails if the source object is a part of a master or a guide. Guides are excluded from any list of shapes returned.
If you specify an invalid shape for pOtherConnectedShape, Microsoft Visio returns an Invalid Parameter error.
GluedShapes returns an empty array if there are no qualifying shapes to return.