How to: Apply a Table Style to a Table

  • 3 minutes to read

To format a table by applying a table style, assign the corresponding TableStyle object to the Table.Style property. Access the required table style object from the IWorkbook.TableStyles collection by the table style name. Built-in table styles can also be obtained by their ids (the BuiltInTableStyleId enumeration members).

A table style consists of the collection of table style elements (TableStyle.TableStyleElements). Each table style element (TableStyleElement) specifies the formatting for a particular element of a table. The TableStyleElementType enumerator lists supported table style element types. The Table object provides the following properties to optionally specify table elements to be formatted as defined by the corresponding elements of the applied table style.

Property Description
Table.ShowHeaders Displays the header row in the table and formats it as specified by the TableStyleElementType.HeaderRow element of the applied table style.
Table.ShowTotals Display the total row in the table and formats it as specified by the TableStyleElementType.TotalRow element of the applied table style.
Table.ShowTableStyleRowStripes Applies striped row formatting to a table as specified by the TableStyleElementType.FirstRowStripe and TableStyleElementType.SecondRowStripe elements of the applied table style.
Table.ShowTableStyleColumnStripes applies striped column formatting to a table as specified by the TableStyleElementType.FirstColumnStripe and TableStyleElementType.SecondColumnStripe elements of the applied table style.
Table.ShowTableStyleFirstColumn Formats the first column of the table as specified by the TableStyleElementType.FirstColumn, TableStyleElementType.FirstHeaderCell and TableStyleElementType.FirstTotalCell elements of the applied table style.
Table.ShowTableStyleLastColumn Formats the last column of the table as specified by the TableStyleElementType.LastColumn, TableStyleElementType.LastHeaderCell and TableStyleElementType.LastTotalCell elements of the applied table style.

This example demonstrates how to access a table style by its name and apply it to an existing table. The Table.ShowHeaders and Table.ShowTotals properties are set to true to show the header and total row of the table.

The Table.ShowTableStyleRowStripes and Table.ShowTableStyleColumnStripes properties are used to apply the striped column formatting to the table.

NOTE

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-format-tables-e4909

void ApplyBuiltInTableStyle(IWorkbook workbook, Table table, string styleName) {
    // Access the workbook's collection of table styles.
    TableStyleCollection tableStyles = workbook.TableStyles;

    // Access the built-in table style from the collection by its name.
    TableStyle tableStyle = tableStyles[styleName];

    // Apply the table style to the existing table.
    table.Style = tableStyle;

    // Show header and total rows.
    table.ShowHeaders = true;
    table.ShowTotals = true;

    // Apply banded column formatting to the table.
    table.ShowTableStyleRowStripes = false;
    table.ShowTableStyleColumnStripes = true;
}

The image below shows the table appearance when the BuiltInTableStyleId.TableStyleMedium21 table style is applied.

TableExample_ApplyStyle

See Also