aspect_ratio_locked property

ShapeBase.aspect_ratio_locked property

Specifies whether the shape’s aspect ratio is locked.

@property
def aspect_ratio_locked(self) -> bool:
    ...

@aspect_ratio_locked.setter
def aspect_ratio_locked(self, value: bool):
    ...

Remarks

The default value depends on the ShapeType, for the ShapeType.IMAGE it is True but for the other shape types it is False.

Has effect for top level shapes only.

Examples

Shows how to lock/unlock a shape’s aspect ratio.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Insert a shape. If we open this document in Microsoft Word, we can left click the shape to reveal
# eight sizing handles around its perimeter, which we can click and drag to change its size.
shape = builder.insert_image(file_name=IMAGE_DIR + 'Logo.jpg')
# Set the "AspectRatioLocked" property to "true" to preserve the shape's aspect ratio
# when using any of the four diagonal sizing handles, which change both the image's height and width.
# Using any orthogonal sizing handles that either change the height or width will still change the aspect ratio.
# Set the "AspectRatioLocked" property to "false" to allow us to
# freely change the image's aspect ratio with all sizing handles.
shape.aspect_ratio_locked = lock_aspect_ratio
doc.save(file_name=ARTIFACTS_DIR + 'Shape.AspectRatio.docx')

See Also

ShapeBase.anchor_locked property ShapeBase.behind_text property