TextSpan.UnderlineWordsOnly Property

Gets whether space and tab characters are underlined in addition to other characters.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public bool? UnderlineWordsOnly { get; }

Property Value

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

Remarks

The Underline property allows you to get whether the text span’s characters are underlined.

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

Use the ChangePropertiesAsync(Action<CharacterProperties>, CancellationToken) method to change whether space and tab characters are underlined in addition to other 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.UnderlineWordsOnly != true)
                    properties.UnderlineWordsOnly = true;
            });
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Implements

UnderlineWordsOnly