TableBorder Class

Contains table border settings.

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v25.1.dll

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public class TableBorder :
    ITableBorder,
    IPropertyContainer<ChangedBordersMask>,
    IDisposable

Related API Members

The following members return TableBorder objects:

• TableBorders.InsideHorizontal
• TableBorders.InsideVertical
• TableBordersBase.Bottom
• TableBordersBase.Left
• TableBordersBase.Right
• TableBordersBase.Top

Remarks

The Rich Text Editor component allows you to specify border settings for the following document elements:

Table

The Table.Borders property allows you to access table borders and obtain their settings. Pass a TableProperties object to the Table.ChangePropertiesAsync method to customize table borders.

Table Cell

The TableCell.Borders property allows you to access table cell borders and obtain their settings. Pass a TableCellProperties object to the TableCell.ChangePropertiesAsync method to customize cell borders.

Note

Cell border settings take priority over table border settings.

The following code example customizes table and cell border settings:

<DxRichEdit @ref="richEdit" />

@code {
    DxRichEdit richEdit;
    protected override async Task OnAfterRenderAsync(bool firstRender) {
        if (firstRender)
            try {
                await InitializeDocument();
            }
            catch (TaskCanceledException) { }
        await base.OnAfterRenderAsync(firstRender);
    }

    async Task InitializeDocument() {
      /* Surround the code that contains an asynchronous operation with a try-catch block to handle
      the OperationCanceledException. This exception is thrown when an asynchronous operation is canceled. */
        try {
            var columnCount = 4;
            var rowCount = 5;
            richEdit.DocumentAPI.BeginUpdate();
            // Creates a table
            Table myTable = await richEdit.DocumentAPI.Tables.CreateAsync(0, columnCount, rowCount);
            for (int i = rowCount-1; i >= 0 ; i--)
                for (int j = columnCount-1; j >=0 ; j--) {
                    var cellPosition = myTable.Rows[i].Cells[j].Interval.Start;
                    await richEdit.DocumentAPI.AddTextAsync(cellPosition, "sample text");
                }
            // Customizes the table
            myTable = await richEdit.DocumentAPI.Tables.GetAsync(0);
            await myTable.ChangePropertiesAsync(properties => {
                properties.Borders = new TableBorders(BorderLineStyle.None, System.Drawing.Color.Black, 20);
                properties.Width = new TableWidth(TableWidthType.Percent, 100);
            });
            foreach (TableCell cell in myTable.Rows[0].Cells) {
                await cell.ChangePropertiesAsync(properties => {
                    properties.Borders.Bottom = new TableBorder(BorderLineStyle.Single, System.Drawing.Color.Black, 20);
                });
            }
            richEdit.DocumentAPI.EndUpdate();
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
    }
}

Implements

ITableBorder

IDisposable

Inheritance

Object

TableBorder