Skip to main content

CharacterProperties.UnderlineColor Property

Specifies the underline color for a text span’s characters.

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v23.2.dll

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public Color? UnderlineColor { get; set; }

Property Value

Type Description
Nullable<Color>

The underline color.

Remarks

The Underline property allows you to underline a text span’s characters. Use UnderlineWordsOnly property to specify whether space and tab characters are underlined in addition to other characters.

When the UnderlineColor property is set to Empty, the underline color of the characters depends on the ForegroundColor property value.

Use the UnderlineColor property to get the underline 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.UnderlineColor != System.Drawing.Color.DarkBlue)
                    properties.UnderlineColor = System.Drawing.Color.DarkBlue;
            });
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also