CharacterProperties.Underline Property

Specifies whether characters are underlined.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public bool? Underline { get; set; }

Property Value

Type	Description
Nullable<Boolean>	true if all characters are underlined; false if no character is underlined; null if only some characters are underlined.

Remarks

Use a text span’s Underline or a table cell’s CharacterProperties.Underline property to identify whether all characters in the span or cell are underlined. Call the TextSpan.ChangePropertiesAsync or TableCell.ChangePropertiesAsync method to apply the underline font attribute to characters, remove it, or change underline appearance.

The following properties affect underline appearance:

UnderlineWordsOnly

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

UnderlineColor

Specifies the underline color. If this property is set to Empty, the underline color of characters depends on the ForegroundColor property value.

The following example underlines all characters in a text span:

<DxRichEdit @ref="richEdit" />

@code {
    DxRichEdit richEdit;
    Document documentAPI;

    protected override async Task OnAfterRenderAsync(bool firstRender) {
        if (firstRender)
            try {
                await InitializeDocument();
            }
            catch (TaskCanceledException) { }
        await base.OnAfterRenderAsync(firstRender);
    }

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

Implements

Underline