is_visible property

Border.is_visible property

Returns True if the Border.line_style is not LineStyle.NONE.

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

Examples

Shows how to remove borders from a paragraph.

doc = aw.Document(MY_DIR + "Borders.docx")

# Each paragraph has an individual set of borders.
# We can access the settings for the appearance of these borders via the paragraph format object.
borders = doc.first_section.body.first_paragraph.paragraph_format.borders

self.assertEqual(drawing.Color.red.to_argb(), borders[0].color.to_argb())
self.assertEqual(3.0, borders[0].line_width)
self.assertEqual(aw.LineStyle.SINGLE, borders[0].line_style)
self.assertTrue(borders[0].is_visible)

# We can remove a border at once by running the "clear_formatting" method.
# Running this method on every border of a paragraph will remove all its borders.
for border in borders:
    border.clear_formatting()

self.assertEqual(drawing.Color.empty().to_argb(), borders[0].color.to_argb())
self.assertEqual(0.0, borders[0].line_width)
self.assertEqual(aw.LineStyle.NONE, borders[0].line_style)
self.assertFalse(borders[0].is_visible)

doc.save(ARTIFACTS_DIR + "Border.clear_formatting.docx")

See Also

Border.distance_from_text property Border.line_style property