.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

TableStyleCollection.Add(String) Method

Creates a new table or pivot table style with the specified name and appends it to the collection of styles.

Namespace: DevExpress.Spreadsheet

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

Declaration

TableStyle Add(
    string name
)
Function Add(
    name As String
) As TableStyle
TableStyle Add(
    string name
)
Function Add(
    name As String
) As TableStyle
TableStyle Add(
    string name
)
Function Add(
    name As String
) As TableStyle

Parameters

Name Type Description
name String

A String value that specifies the style name. Initializes the TableStyle.Name property of the created style.

Parameters

Name Type Description
name String

A String value that specifies the style name. Initializes the TableStyle.Name property of the created style.

Parameters

Name Type Description
name String

A String value that specifies the style name. Initializes the TableStyle.Name property of the created style.

Returns

Type Description
TableStyle

A TableStyle object that specifies the newly created style.

Returns

Type Description
TableStyle

A TableStyle object that specifies the newly created style.

Returns

Type Description
TableStyle

A TableStyle object that specifies the newly created style.

Remarks

Call the Add method to create a custom table or pivot table style. Set the TableStyle.IsTableStyle and TableStyle.IsPivotStyle properties to the appropriate values, depending on whether the created style should be used for a table or pivot table. To ensure that the collection does not already contain a style under the specified name, use the TableStyleCollection.Contains method.

To create a new table or pivot table style that copies all the format settings of an existing style, use the TableStyle.Duplicate method.

Examples

This example demonstrates how to create a custom style to format tables.

  1. Add a new table style to the IWorkbook.TableStyles collection by calling the TableStyleCollection.Add method with the table style name passed as a parameter. This method returns the TableStyle object that represents the newly created table style. This object's TableStyle.Name property is set to the specified name. Other settings are identical to the None table style (the default built-in table style that specifies no formatting for a table).

    Note

    Note that table styles have unique names in the collection. To ensure that there is no table style under the specified name in the collection, use the TableStyleCollection.Contains method.

  2. Modify elements of the created table style (TableStyle.TableStyleElements) within the TableStyle.BeginUpdate and TableStyle.EndUpdate paired methods.
' Access a table.
Dim table As Table = worksheet.Tables(0)

Dim styleName As String = "testTableStyle"

' If the style under the specified name already exists in the collection,
If workbook.TableStyles.Contains(styleName) Then
    ' apply this style to the table.
    table.Style = workbook.TableStyles(styleName)
Else
    ' Add a new table style under the "testTableStyle" name to the TableStyles collection.

    Dim customTableStyle_Renamed As TableStyle = workbook.TableStyles.Add("testTableStyle")

    ' Modify the required formatting characteristics of the table style. 
    ' Specify the format for different table elements.
    customTableStyle_Renamed.BeginUpdate()
    Try
        customTableStyle_Renamed.TableStyleElements(TableStyleElementType.WholeTable).Font.Color = Color.FromArgb(107, 107, 107)

        ' Specify formatting characteristics for the table header row. 
        Dim headerRowStyle As TableStyleElement = customTableStyle_Renamed.TableStyleElements(TableStyleElementType.HeaderRow)
        headerRowStyle.Fill.BackgroundColor = Color.FromArgb(64, 66, 166)
        headerRowStyle.Font.Color = Color.White
        headerRowStyle.Font.Bold = True

        ' Specify formatting characteristics for the table total row. 
        Dim totalRowStyle As TableStyleElement = customTableStyle_Renamed.TableStyleElements(TableStyleElementType.TotalRow)
        totalRowStyle.Fill.BackgroundColor = Color.FromArgb(115, 193, 211)
        totalRowStyle.Font.Color = Color.White
        totalRowStyle.Font.Bold = True

        ' Specify banded row formatting for the table.
        Dim secondRowStripeStyle As TableStyleElement = customTableStyle_Renamed.TableStyleElements(TableStyleElementType.SecondRowStripe)
        secondRowStripeStyle.Fill.BackgroundColor = Color.FromArgb(234, 234, 234)
        secondRowStripeStyle.StripeSize = 1
    Finally
        customTableStyle_Renamed.EndUpdate()
    End Try
    ' Apply the created custom style to the table.
    table.Style = customTableStyle_Renamed
End If
See Also