TableStyleOptions enumeration

TableStyleOptions enumeration

Specifies how table style is applied to a table.

Members

NameDescription
NONENo table style formatting is applied.
FIRST_ROWApply first row conditional formatting.
LAST_ROWApply last row conditional formatting.
FIRST_COLUMNApply 1 first column conditional formatting.
LAST_COLUMNApply last column conditional formatting.
ROW_BANDSApply row banding conditional formatting.
COLUMN_BANDSApply column banding conditional formatting.
DEFAULT2003Row and column banding is applied. This is Microsoft Word default for old formats such as DOC, WML and RTF.
DEFAULTThis is Microsoft Word defaults.

Examples

Shows how to build a new table while applying a style.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
table = builder.start_table()
# We must insert at least one row before setting any table formatting.
builder.insert_cell()
# Set the table style used based on the style identifier.
# Note that not all table styles are available when saving to .doc format.
table.style_identifier = aw.StyleIdentifier.MEDIUM_SHADING1_ACCENT1
# Partially apply the style to features of the table based on predicates, then build the table.
table.style_options = aw.tables.TableStyleOptions.FIRST_COLUMN | aw.tables.TableStyleOptions.ROW_BANDS | aw.tables.TableStyleOptions.FIRST_ROW
table.auto_fit(aw.tables.AutoFitBehavior.AUTO_FIT_TO_CONTENTS)
builder.writeln('Item')
builder.cell_format.right_padding = 40
builder.insert_cell()
builder.writeln('Quantity (kg)')
builder.end_row()
builder.insert_cell()
builder.writeln('Apples')
builder.insert_cell()
builder.writeln('20')
builder.end_row()
builder.insert_cell()
builder.writeln('Bananas')
builder.insert_cell()
builder.writeln('40')
builder.end_row()
builder.insert_cell()
builder.writeln('Carrots')
builder.insert_cell()
builder.writeln('50')
builder.end_row()
doc.save(file_name=ARTIFACTS_DIR + 'DocumentBuilder.InsertTableWithStyle.docx')

See Also

TableCollection class TextWrapping enumeration