is_decorative property

ShapeBase.is_decorative property

Gets or sets the flag that specifies whether the shape is decorative in the document.

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

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

Remarks

Note that shape having not empty ShapeBase.alternative_text cannot be decorative.

Examples

Shows how to set that the shape is decorative.

doc = aw.Document(file_name=MY_DIR + 'Decorative shapes.docx')
shape = doc.get_child_nodes(aw.NodeType.SHAPE, True)[0].as_shape()
self.assertTrue(shape.is_decorative)
# If "AlternativeText" is not empty, the shape cannot be decorative.
# That's why our value has changed to 'false'.
shape.alternative_text = 'Alternative text.'
self.assertFalse(shape.is_decorative)
builder = aw.DocumentBuilder(doc=doc)
builder.move_to_document_end()
# Create a new shape as decorative.
shape = builder.insert_shape(shape_type=aw.drawing.ShapeType.RECTANGLE, width=100, height=100)
shape.is_decorative = True
doc.save(file_name=ARTIFACTS_DIR + 'Shape.IsDecorative.docx')

See Also