Python XlsxWriter - Border

This section describes how to apply and format the appearance of cell border as well as a border around text box.

Working with Cell Border

The properties in the add_format() method that control the appearance of cell border are as shown in the following table −

Note that for each property of add_format() method, there is a corresponding format class method starting with the set_propertyname() method.

For example, to set a border around a cell, we can use border property in add_format() method as follows −

f1= wb.add_format({  border :2})

The same action can also be done by calpng the set_border() method −

f1 = workbook.add_format()
f1.set_border(2)

Inspanidual border elements can be configured by the properties or format methods as follows −

set_bottom()

set_top()

set_left()

set_right()

These border methods/properties have an integer value corresponding to the predefined styles as in the following table −

Example

Following code shows how the border property is used. Here, each row is having a border style 2 corresponding to continuous bold.

import xlsxwriter

wb = xlsxwriter.Workbook( hello.xlsx )
ws = wb.add_worksheet()

f1=wb.add_format({ bold :True,  border :2,  border_color : red })
f2=wb.add_format({ border :2,  border_color : red })

headings = [ Month ,  Product A ,  Product B ]

data = [
   [ Jan ,  Feb ,  Mar ,  Apr ,  May ,  June ],
   [10, 40, 50, 20, 10, 50],
   [30, 60, 70, 50, 40, 30],
]

ws.write_row( A1 , headings, f1)
ws.write_column( A2 , data[0], f2)
ws.write_column( B2 , data[1],f2)
ws.write_column( C2 , data[2],f2)

wb.close()

Output

The worksheet shows a bold border around the cells.

Working with Textbox Border

The border property is also available for the text box object. The text box also has a pne property which is similar to border, so that they can be used interchangeably. The border itself can further be formatted by none, color, width and dash_type parameters.

Line or border set to none means that the text box will not have any border. The dash_type parameter can be any of the following values −

sopd

round_dot

square_dot

dash

dash_dot

long_dash

long_dash_dot

long_dash_dot_dot

Example

Here is a program that displays two text boxes, one with a sopd border, red in color; and the second box has dash_dot type border in blue color.

import xlsxwriter

wb = xlsxwriter.Workbook( hello.xlsx )
ws = wb.add_worksheet()

ws.insert_textbox( B2 ,  Welcome to Tutorialspoint ,
{ border : { color :  #FF9900 }})

ws.insert_textbox( B10 ,  Welcome to Tutorialspoint , {
    pne :
   { color :  blue ,  dash_type :  dash_dot }
})
wb.close()

Output

The output worksheet shows the textbox borders.