bounds property

ShapeBase.bounds property

Gets or sets the location and size of the containing block of the shape.

@property
def bounds(self) -> aspose.pydrawing.RectangleF:
    ...

@bounds.setter
def bounds(self, value: aspose.pydrawing.RectangleF):
    ...

Remarks

Ignores aspect ratio lock upon setting.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

Examples

Shows how to create and populate a group shape.

doc = aw.Document()

# Create a group shape. A group shape can display a collection of child shape nodes.
# In Microsoft Word, clicking within the group shape's boundary or on one of the group shape's child shapes will
# select all the other child shapes within this group and allow us to scale and move all the shapes at once.
group = aw.drawing.GroupShape(doc)

self.assertEqual(aw.drawing.WrapType.NONE, group.wrap_type)

# Create a 400pt x 400pt group shape and place it at the document's floating shape coordinate origin.
group.bounds = drawing.RectangleF(0, 0, 400, 400)

# Set the group's internal coordinate plane size to 500 x 500pt.
# The top left corner of the group will have an x and y coordinate of (0, 0),
# and the bottom right corner will have an x and y coordinate of (500, 500).
group.coord_size = drawing.Size(500, 500)

# Set the coordinates of the top left corner of the group to (-250, -250).
# The group's center will now have an x and y coordinate value of (0, 0),
# and the bottom right corner will be at (250, 250).
group.coord_origin = drawing.Point(-250, -250)

# Create a rectangle that will display the boundary of this group shape and add it to the group.
rectangle = aw.drawing.Shape(doc, aw.drawing.ShapeType.RECTANGLE)
rectangle.width = group.coord_size.width
rectangle.height = group.coord_size.height
rectangle.left = group.coord_origin.x
rectangle.top = group.coord_origin.y
group.append_child(rectangle)

# Once a shape is a part of a group shape, we can access it as a child node and then modify it.
group.get_child(aw.NodeType.SHAPE, 0, True).as_shape().stroke.dash_style = aw.drawing.DashStyle.DASH

# Create a small red star and insert it into the group.
# Line up the shape with the group's coordinate origin, which we have moved to the center.
red_star = aw.drawing.Shape(doc, aw.drawing.ShapeType.STAR)
red_star.width = 20
red_star.height = 20
red_star.left = -10
red_star.top = -10
red_star.fill_color = drawing.Color.red
group.append_child(red_star)

# Insert a rectangle, and then insert a slightly smaller rectangle in the same place with an image.
# Newer shapes that we add to the group overlap older shapes. The light blue rectangle will partially overlap the red star,
# and then the shape with the image will overlap the light blue rectangle, using it as a frame.
# We cannot use the "z_order" properties of shapes to manipulate their arrangement within a group shape.
blue_rectangle = aw.drawing.Shape(doc, aw.drawing.ShapeType.RECTANGLE)
blue_rectangle.width = 250
blue_rectangle.height = 250
blue_rectangle.left = -250
blue_rectangle.top = -250
blue_rectangle.fill_color = drawing.Color.light_blue
group.append_child(blue_rectangle)

image = aw.drawing.Shape(doc, aw.drawing.ShapeType.IMAGE)
image.width = 200
image.height = 200
image.left = -225
image.top = -225
group.append_child(image)

group.get_child(aw.NodeType.SHAPE, 3, True).as_shape().image_data.set_image(IMAGE_DIR + "Logo.jpg")

# Insert a text box into the group shape. Set the "left" property so that the text box's right edge
# touches the right boundary of the group shape. Set the "top" property so that the text box sits outside
# the boundary of the group shape, with its top size lined up along the group shape's bottom margin.
text_box = aw.drawing.Shape(doc, aw.drawing.ShapeType.TEXT_BOX)
text_box.width = 200
text_box.height = 50
text_box.left = group.coord_size.width + group.coord_origin.x - 200
text_box.top = group.coord_size.height + group.coord_origin.y
group.append_child(text_box)

builder = aw.DocumentBuilder(doc)
builder.insert_node(group)
builder.move_to(group.get_child(aw.NodeType.SHAPE, 4, True).as_shape().append_child(aw.Paragraph(doc)))
builder.write("Hello world!")

doc.save(ARTIFACTS_DIR + "Shape.group_shape.docx")

Shows how to verify shape containing block boundaries.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

shape = builder.insert_shape(aw.drawing.ShapeType.LINE, aw.drawing.RelativeHorizontalPosition.LEFT_MARGIN, 50,
    aw.drawing.RelativeVerticalPosition.TOP_MARGIN, 50, 100, 100, aw.drawing.WrapType.NONE)
shape.stroke_color = drawing.Color.orange

# Even though the line itself takes up little space on the document page,
# it occupies a rectangular containing block, the size of which we can determine using the "bounds" properties.
self.assertEqual(drawing.RectangleF(50, 50, 100, 100), shape.bounds)
self.assertEqual(drawing.RectangleF(50, 50, 100, 100), shape.bounds_in_points)

# Create a group shape, and then set the size of its containing block using the "Bounds" property.
group = aw.drawing.GroupShape(doc)
group.bounds = drawing.RectangleF(0, 100, 250, 250)

self.assertEqual(drawing.RectangleF(0, 100, 250, 250), group.bounds_in_points)

# Create a rectangle, verify the size of its bounding block, and then add it to the group shape.
shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.RECTANGLE)
shape.width = 100
shape.height = 100
shape.left = 700
shape.top = 700

self.assertEqual(drawing.RectangleF(700, 700, 100, 100), shape.bounds_in_points)

group.append_child(shape)

# The group shape's coordinate plane has its origin on the top left-hand side corner of its containing block,
# and the x and y coordinates of (1000, 1000) on the bottom right-hand side corner.
# Our group shape is 250x250pt in size, so every 4pt on the group shape's coordinate plane
# translates to 1pt in the document body's coordinate plane.
# Every shape that we insert will also shrink in size by a factor of 4.
# The change in the shape's "bounds_in_points" property will reflect this.
self.assertEqual(drawing.RectangleF(175, 275, 25, 25), shape.bounds_in_points)

doc.first_section.body.first_paragraph.append_child(group)

# Insert a shape and place it outside of the bounds of the group shape's containing block.
shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.RECTANGLE)
shape.width = 100
shape.height = 100
shape.left = 1000
shape.top = 1000

group.append_child(shape)

# The group shape's footprint in the document body has increased, but the containing block remains the same.
self.assertEqual(drawing.RectangleF(0, 100, 250, 250), group.bounds_in_points)
self.assertEqual(drawing.RectangleF(250, 350, 25, 25), shape.bounds_in_points)

doc.save(ARTIFACTS_DIR + "Shape.bounds.docx")

bounds property

ShapeBase.bounds property

Remarks

Examples

See Also