TextSpan.Underline Property

Gets whether the text span’s characters are underlined.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public bool? Underline { get; }

Property Value

Type	Description
Nullable<Boolean>	true if characters are underlined; false if characters are not underlined; null for a combination of true and false.

Remarks

The UnderlineColor property defines the underline color of a text span’s characters. If this property is set to Empty, the underline color depends on the ForegroundColor property value.

The UnderlineWordsOnly property allows you to get whether space and tab characters are underlined in addition to other characters.

Use the ChangePropertiesAsync(Action<CharacterProperties>, CancellationToken) method to change whether a text span’s characters are underlined.

<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.Underline != true)
                    properties.Underline = true;
            });
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}