TableStyle Interface

A named table or pivot table style.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public interface TableStyle

VB.NET

Public Interface TableStyle

Related API Members

The following members return TableStyle objects:

• PivotTable.Style
• Table.Style
• TableStyle.Duplicate()
• TableStyle.Duplicate(String)
• TableStyleCollection.Add(String)
• TableStyleCollection.DefaultPivotStyle
• TableStyleCollection.DefaultStyle
• TableStyleCollection.Item[BuiltInPivotStyleId]
• TableStyleCollection.Item[BuiltInTableStyleId]
• TableStyleCollection.Item[String]

Remarks

Table and pivot table styles are contained within the TableStyleCollection object accessible via the IWorkbook.TableStyles property. This collection includes a set of built-in styles (similar to Microsoft® Excel®) that can be obtained by the corresponding BuiltInTableStyleId or BuiltInPivotStyleId enumeration members and custom styles that can be accessed by their names (TableStyle.Name). Built-in styles are contained in the collection by default, while custom styles can be added via the TableStyleCollection.Add or TableStyle.Duplicate methods.

A table style consists of a collection of table style elements. These elements are stored in the TableStyleElements collection that is returned by the TableStyle.TableStyleElements property. Each table style element is represented by the TableStyleElement object and is accessed by the corresponding member of the TableStyleElementType enumeration. A TableStyleElement object provides the TableStyleElement.Borders, TableStyleElement.Fill and TableStyleElement.Font properties to specify the formatting for a particular element of a table. See this topic for details: How to: Create and Modify Table Styles document for details.

To apply a style to a table, use the Table.Style property (see the How to: Apply a Table Style to a Table example). To apply a style to a pivot table, use the PivotTable.Style property (see the How to: Apply a Predefined Style to a Pivot Table example).

Example

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.

Form1.vb

Private Sub ApplyBuiltInTableStyle(ByVal workbook As IWorkbook, ByVal table As Table, ByVal styleName As String)
    ' Access the workbook's collection of table styles.
    Dim tableStyles As TableStyleCollection = workbook.TableStyles

    ' Access the built-in table style from the collection by its name.
    Dim tableStyle As 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
End Sub

Form1.cs

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;
}