Border class

Border class

Represents a border of an object. To learn more, visit the Programming with Documents documentation article.

Remarks

Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.

Inheritance: Border → InternableComplexAttr

Properties

NameDescription
colorGets or sets the border color.
distance_from_textGets or sets distance of the border from text or from the page edge in points.
is_visibleReturns True if the Border.line_style is not LineStyle.NONE.
line_styleGets or sets the border style.
line_widthGets or sets the border width in points.
shadowGets or sets a value indicating whether the border has a shadow.
theme_colorGets or sets the theme color in the applied color scheme that is associated with this Border object.
tint_and_shadeGets or sets a double value that lightens or darkens a color.

Methods

NameDescription
clear_formatting()Resets border properties to default values.
equals(rhs)Determines whether the specified border is equal in value to the current border.

Examples

Shows how to insert a string surrounded by a border into a document.

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

builder.font.border.color = drawing.Color.green
builder.font.border.line_width = 2.5
builder.font.border.line_style = aw.LineStyle.DASH_DOT_STROKER

builder.write("Text surrounded by green border.")

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

Shows how to insert a paragraph with a top border.

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

top_border = builder.paragraph_format.borders.top
top_border.line_width = 4.0
top_border.line_style = aw.LineStyle.DASH_SMALL_GAP
# Set ThemeColor only when LineWidth or LineStyle setted.
top_border.theme_color = awthemes.ThemeColor.ACCENT1
top_border.tint_and_shade = 0.25

builder.writeln("Text with a top border.")

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

See Also

BookmarkStart class BorderCollection class