height property

HorizontalRuleFormat.height property

Gets or sets the height of the horizontal rule.

@property
def height(self) -> float:
    ...

@height.setter
def height(self, value: float):
    ...

Exceptions

exceptioncondition
RuntimeError (Proxy error(ArgumentOutOfRangeException))Throws when argument was out of the range of valid values.

Remarks

This is a shortcut to the ShapeBase.height property.

Valid values ​​range from 0 to 1584 inclusive.

The default value is 1.5.

Examples

Shows how to insert a horizontal rule shape, and customize its formatting.

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

horizontal_rule_format = shape.horizontal_rule_format
horizontal_rule_format.alignment = aw.drawing.HorizontalRuleAlignment.CENTER
horizontal_rule_format.width_percent = 70
horizontal_rule_format.height = 3
horizontal_rule_format.color = drawing.Color.blue
horizontal_rule_format.no_shade = True

self.assertTrue(shape.is_horizontal_rule)
self.assertTrue(shape.horizontal_rule_format.no_shade)

See Also