CharacterProperties.Underline Property

Specifies whether a 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; set; }

Property Value

Type	Description
Nullable<Boolean>	true to underline characters; otherwise, false.

Remarks

The UnderlineColor property specifies the underline color for 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 specify whether to underline space and tab characters in addition to other characters.

Use the Underline property to get 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}");
        }
}