TableStyleElement.Clear() Method

Removes existing formatting from the table style element.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

void Clear()

VB.NET

Sub Clear

Example

You can create new custom table styles based on existing table styles (for example, based on built-in table styles). To do this, use the TableStyle.Duplicate method. This method creates a copy of the specified style and returns the TableStyle object representing the newly created style. You can use properties of this object to change the style format settings.

For example, the code snippet below demonstrates how to duplicate an existing style and modify the new style a bit by removing the table header row formatting copied from the source table style.

Note

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

Form1.vb

Private Function DuplicateAndModifyTableStyle(ByVal workbook As IWorkbook, ByVal sourceStyleName As String) As TableStyle
    ' Get the table style to be duplicated.
    Dim sourceTableStyle As TableStyle = workbook.TableStyles(sourceStyleName)

    ' Duplicate the table style.
    Dim newTableStyle As TableStyle = sourceTableStyle.Duplicate()

    ' Modify the required formatting characteristics of the created table style.
    ' For example, remove exisitng formatting from the header row element.
    newTableStyle.TableStyleElements(TableStyleElementType.HeaderRow).Clear()

    Return newTableStyle
End Function

Form1.cs

TableStyle DuplicateAndModifyTableStyle(IWorkbook workbook, string sourceStyleName) {
    // Get the table style to be duplicated.
    TableStyle sourceTableStyle = workbook.TableStyles[sourceStyleName];

    // Duplicate the table style.
    TableStyle newTableStyle = sourceTableStyle.Duplicate();

    // Modify the required formatting characteristics of the created table style.
    // For example, remove exisitng formatting from the header row element.
    newTableStyle.TableStyleElements[TableStyleElementType.HeaderRow].Clear();

    return newTableStyle;
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Clear() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-format-tables-e4909/CS/TableBuiltInStyleExample/Form1.cs#L224

// For example, remove exisitng formatting from the header row element.
newTableStyle.TableStyleElements[TableStyleElementType.HeaderRow].Clear();

VB.NET

how-to-format-tables-e4909/VB/TableBuiltInStyleExample/Form1.vb#L223

' For example, remove exisitng formatting from the header row element.
newTableStyle.TableStyleElements(TableStyleElementType.HeaderRow).Clear()