Skip to main content

CharacterProperties.UnderlineWordsOnly Property

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

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public bool? UnderlineWordsOnly { get; set; }

Property Value

Type Description
Nullable<Boolean>

true to underline all characters except for space and tab characters; false to underline all characters.

Remarks

The Underline property allows you to underline the text span’s characters.

The UnderlineColor property specifies 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 UnderlineWordsOnly property to get 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}");
        }
}
See Also