ICharacterProperties.BackgroundColor Property
Returns the background color of characters.
Namespace: DevExpress.Blazor.RichEdit
Assembly: DevExpress.Blazor.RichEdit.v24.2.dll
NuGet Package: DevExpress.Blazor.RichEdit
Declaration
Color? BackgroundColor { get; }
Property Value
Type | Description |
---|---|
Nullable<Color> | The background color or |
Remarks
A cell stores its text formatting settings in the CharacterProperties property. Call the cell’s ChangePropertiesAsync method to change the background color of cell characters.
Note
The highlight color overlaps the background color.
The following example specifies the background color for all characters in a table:
<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);
foreach (TableRow row in myTable.Rows)
foreach (TableCell cell in row.Cells)
if (cell.CharacterProperties.BackgroundColor != System.Drawing.Color.AntiqueWhite)
await cell.ChangePropertiesAsync(properties => {
properties.CharacterProperties.BackgroundColor = System.Drawing.Color.AntiqueWhite;
});
richEdit.DocumentAPI.EndUpdate();
}
catch (OperationCanceledException e) {
Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
}
}
}
See Also