CharacterProperties.BackgroundColor Property
Specifies the background color of characters.
Namespace: DevExpress.Blazor.RichEdit
Assembly: DevExpress.Blazor.RichEdit.v24.2.dll
NuGet Package: DevExpress.Blazor.RichEdit
Declaration
public Color? BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Nullable<Color> | The background color or |
Remarks
Use a text span’s BackgroundColor property or a table cell’s CharacterProperties.BackgroundColor property to obtain the background color of characters in the span or cell. Call the TextSpan.ChangePropertiesAsync or TableCell.ChangePropertiesAsync method to change the background color of characters.
Note
The highlight color overlaps the background color.
The following example specifies the background color for all characters in a text span:
<DxRichEdit @ref="richEdit" />
@code {
DxRichEdit richEdit;
Document documentAPI;
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 {
documentAPI = richEdit.DocumentAPI;
TextSpan characters = await documentAPI.AddTextAsync("New Text");
await characters.ChangePropertiesAsync(properties => {
properties.BackgroundColor = System.Drawing.Color.AntiqueWhite;
});
}
catch (OperationCanceledException e) {
Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
}
}
}