ReflectionFormat class

ReflectionFormat class

Represents the reflection formatting for an object.

Remarks

Use the ShapeBase.reflection property to access reflection properties of an object. You do not create instances of the ReflectionFormat class directly.

Properties

NameDescription
blurGets or sets a double value that specifies the degree of blur effect applied to the reflection effect in points. The default value is 0.0.
distanceGets or sets a double value that specifies the amount of separation of the reflected image from the object in points. The default value is 0.0.
sizeGets or sets a double value between 0.0 and 1.0 representing the size of the reflection as a percentage of the reflected object. The default value is 0.0.
transparencyGets or sets a double value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency for the reflection effect. The default value is 0.0.

Methods

NameDescription
remove()Removes ReflectionFormat from the parent object.

Examples

Shows how to interact with reflection shape effect.

doc = aw.Document(file_name=MY_DIR + 'Various shapes.docx')
shape = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
shape.reflection.transparency = 0.37
shape.reflection.size = 0.48
shape.reflection.blur = 17.5
shape.reflection.distance = 9.2
doc.save(file_name=ARTIFACTS_DIR + 'Shape.Reflection.docx')
doc = aw.Document(file_name=ARTIFACTS_DIR + 'Shape.Reflection.docx')
shape = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
reflection_format = shape.reflection
self.assertAlmostEqual(0.37, reflection_format.transparency, delta=0.01)
self.assertAlmostEqual(0.48, reflection_format.size, delta=0.01)
self.assertAlmostEqual(17.5, reflection_format.blur, delta=0.01)
self.assertAlmostEqual(9.2, reflection_format.distance, delta=0.01)
reflection_format.remove()
self.assertEqual(0, reflection_format.transparency)
self.assertEqual(0, reflection_format.size)
self.assertEqual(0, reflection_format.blur)
self.assertEqual(0, reflection_format.distance)

See Also