IdxRichEditTable.TableBackgroundColor Property

Specifies the table’s background color.

Declaration

property TableBackgroundColor: TdxAlphaColor read; write;

Property Value

Type	Description
TdxAlphaColor	A background color.

Remarks

Use the TableBackgroundColor property to change the background fill color.

Value Type

The TableBackgroundColor property accepts TdxAlphaColor values instead of TColor to support transparency.

You can use the TdxAlphaColors record declared in the dxCoreGraphics unit to obtain compatible predefined colors or create custom TdxAlphaColor values. Alternatively, you can call the dxMakeAlphaColor function or other global methods declared in the same unit.

Code Example: Create and Customize a Table

The following code example creates a table populated with three columns and rows at the current caret position and customizes the table’s borders and background:

Delphi

uses
  dxCoreGraphics;  // This unit declares TdxAlphaColor and TdxAlphaColors types
// ...
var
  ADocument: IdxRichEditDocument;
  ATable: IdxRichEditTable;
  I, J: Integer;
begin
  ADocument := dxRichEditControl1.Document;
  ADocument.BeginUpdate;  // Initiates the following batch change
  try
    ATable := ADocument.Tables.Add(ADocument.CaretPosition, 3, 3);
    for I := 0 to ATable.Rows.Count - 1 do
      for J := 0 to ATable.Rows.Self[I].Cells.Count - 1 do
        ADocument.InsertText(ATable.Cell(I, J).Range.Start, 'Lorem ipsum dolor sit amet');
    ATable.Borders.InsideHorizontalBorder.LineStyle := TdxRichEditTableBorderLineStyle.DotDotDash;
    ATable.Borders.InsideHorizontalBorder.LineColor := TdxAlphaColors.Firebrick;
    ATable.Borders.InsideVerticalBorder.LineStyle := TdxRichEditTableBorderLineStyle.Dotted;
    ATable.Borders.Bottom.LineStyle := TdxRichEditTableBorderLineStyle.ThinThickMediumGap;
    ATable.Borders.Bottom.LineThickness := 1.5;
    ATable.Borders.Bottom.LineColor := TdxAlphaColors.Red;
    ATable.Borders.Left.LineStyle := TdxRichEditTableBorderLineStyle.ThinThickMediumGap;
    ATable.Borders.Left.LineColor := TdxAlphaColors.Red;
    ATable.Borders.Left.LineThickness := 1.5;
    ATable.Borders.Right.LineStyle := TdxRichEditTableBorderLineStyle.ThinThickMediumGap;
    ATable.Borders.Right.LineColor := TdxAlphaColors.Red;
    ATable.Borders.Right.LineThickness := 1.5;
    ATable.Borders.Top.LineStyle := TdxRichEditTableBorderLineStyle.ThinThickMediumGap;
    ATable.Borders.Top.LineColor := TdxAlphaColors.Red;
    ATable.Borders.Top.LineThickness := 1.5;
    ATable.TableBackgroundColor := TdxAlphaColors.LightSalmon;
  finally
    ADocument.EndUpdate;  // Calls EndUpdate regardless of the batch operation's success
  end;
end;

C++

#include "dxCoreGraphics.hpp"  // This header declares TdxAlphaColor and TdxAlphaColors types
// ...
  _di_IdxRichEditDocument ADocument;
  _di_IdxRichEditTable ATable;
  // ...
  ADocument = dxRichEditControl1->Document;
  ADocument->BeginUpdate();  // Initiates the following batch change
  try
  {
    ATable = ADocument->Tables->Add(ADocument->CaretPosition, 3, 3);
    for(int i = 0; i < ATable->Rows->Count; i++)
      for(int j = 0; j < ATable->Rows->Self[i]->Cells->Count; j++)
        ADocument->InsertText(ATable->Cell(i, j)->Range->Start, "Lorem ipsum dolor sit amet");
    ATable->Borders->InsideHorizontalBorder->LineStyle = TdxRichEditTableBorderLineStyle::DotDotDash;
    ATable->Borders->InsideHorizontalBorder->LineColor = TdxAlphaColors::Firebrick;
    ATable->Borders->InsideVerticalBorder->LineStyle = TdxRichEditTableBorderLineStyle::Dotted;
    ATable->Borders->Bottom->LineStyle = TdxRichEditTableBorderLineStyle::ThinThickMediumGap;
    ATable->Borders->Bottom->LineThickness = 1.5f;
    ATable->Borders->Bottom->LineColor = TdxAlphaColors::Red;
    ATable->Borders->Left->LineStyle = TdxRichEditTableBorderLineStyle::ThinThickMediumGap;
    ATable->Borders->Left->LineColor = TdxAlphaColors::Red;
    ATable->Borders->Left->LineThickness = 1.5f;
    ATable->Borders->Right->LineStyle = TdxRichEditTableBorderLineStyle::ThinThickMediumGap;
    ATable->Borders->Right->LineColor = TdxAlphaColors::Red;
    ATable->Borders->Right->LineThickness = 1.5f;
    ATable->Borders->Top->LineStyle = TdxRichEditTableBorderLineStyle::ThinThickMediumGap;
    ATable->Borders->Top->LineColor = TdxAlphaColors::Red;
    ATable->Borders->Top->LineThickness = 1.5f;
    ATable->TableBackgroundColor = TdxAlphaColors::LightSalmon;
  }
  __finally
  {
    ADocument->EndUpdate();  // Calls EndUpdate regardless of the batch operation's success
  }