Table.TableBackgroundColor Property

Gets or sets the color of an empty space between cells.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

Color TableBackgroundColor { get; set; }

VB.NET

Property TableBackgroundColor As Color

Property Value

Type	Description
Color	A Color that is the color of the background.

Remarks

By default, there is no empty space between cells. To specify a distance between cells, use the Table.TableCellSpacing property. The TableBackgroundColor is applied to an area around the cells with the width equal to double the Table.TableCellSpacing property value.

To change the cell background, use the TableCell.BackgroundColor property.

Important

The semi-transparent alpha component (i.e. the Color’s alpha parameter set to value less than 255) is reset to opaque (255) during export to Word formats.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Table.vb

    ' Create a table.
    Dim table As Table = document.Tables.Create(document.Range.Start, 3, 5, AutoFitBehaviorType.AutoFitToWindow)
    table.BeginUpdate()
    ' Provide the space between table cells.
    ' The distance between cells will be 4 mm.
    document.Unit = DevExpress.Office.DocumentUnit.Millimeter
    table.TableCellSpacing = 2
    ' Change the color of empty space between cells.
    table.TableBackgroundColor = Color.Violet
    'Change cell background color.
    table.ForEachCell(New TableCellProcessorDelegate(AddressOf TableHelper.ChangeCellColor))
    table.ForEachCell(New TableCellProcessorDelegate(AddressOf TableHelper.ChangeCellBorderColor))
    table.EndUpdate()
Private Class TableHelper
    Public Shared Sub ChangeCellColor(ByVal cell As TableCell, ByVal i As Integer, ByVal j As Integer)
        cell.BackgroundColor = System.Drawing.Color.Yellow
    End Sub

    Public Shared Sub ChangeCellBorderColor(ByVal cell As TableCell, ByVal i As Integer, ByVal j As Integer)
        cell.Borders.Bottom.LineColor = System.Drawing.Color.Red
        cell.Borders.Left.LineColor = System.Drawing.Color.Red
        cell.Borders.Right.LineColor = System.Drawing.Color.Red
        cell.Borders.Top.LineColor = System.Drawing.Color.Red
    End Sub
End Class

Table.cs

    // Create a table.
    Table table = document.Tables.Create(document.Range.Start, 3, 5, AutoFitBehaviorType.AutoFitToWindow);
    table.BeginUpdate();
    // Provide the space between table cells.
    // The distance between cells will be 4 mm.
    document.Unit = DevExpress.Office.DocumentUnit.Millimeter;
    table.TableCellSpacing = 2;
    // Change the color of empty space between cells.
    table.TableBackgroundColor = Color.Violet;
    //Change cell background color.
    table.ForEachCell(new TableCellProcessorDelegate(TableHelper.ChangeCellColor));
    table.ForEachCell(new TableCellProcessorDelegate(TableHelper.ChangeCellBorderColor));
    table.EndUpdate();
class TableHelper
{
    public static void ChangeCellColor(TableCell cell, int i, int j)
    {
        cell.BackgroundColor = System.Drawing.Color.Yellow;
    }

    public static void ChangeCellBorderColor(TableCell cell, int i, int j)
    {
        cell.Borders.Bottom.LineColor = System.Drawing.Color.Red;
        cell.Borders.Left.LineColor = System.Drawing.Color.Red;
        cell.Borders.Right.LineColor = System.Drawing.Color.Red;
        cell.Borders.Top.LineColor = System.Drawing.Color.Red;
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TableBackgroundColor property.

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#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/TableActions.cs#L179

// Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet;
//Change cell background color.

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Table.cs#L78

// Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet;
//Change cell background color.

word-document-api-examples/CS/CodeExamples/TablesActions.cs#L86

// Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet;
//Change cell background color.

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/TableActions.vb#L160

' Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet
'Change cell background color.

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Table.vb#L68

' Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet
'Change cell background color.

word-document-api-examples/VB/CodeExamples/TablesActions.vb#L76

' Change the color of empty space between cells.
table.TableBackgroundColor = Color.Violet
'Change cell background color.