TextSpan.BackgroundColor Property

Gets the background color of the text span’s characters.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public Color? BackgroundColor { get; }

Property Value

Type	Description
Nullable<Color>	The background color or null for a variety of colors.

Remarks

The highlight color overlaps the background color.

Use the ChangePropertiesAsync(Action<CharacterProperties>, CancellationToken) method to change the background color of a text span’s characters.

<DxRichEdit @ref="richEdit" />

@code {
    DxRichEdit richEdit;
    Document documentAPI;
    @* ... *@
    /* 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 => {
                if (characters.BackgroundColor != System.Drawing.Color.AntiqueWhite)
                    properties.BackgroundColor = System.Drawing.Color.AntiqueWhite;
            });
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Implements

BackgroundColor