Skip to main content

CharacterProperties.Strikeout Property

Specifies whether characters are stricken out.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public bool? Strikeout { get; set; }

Property Value

Type Description
Nullable<Boolean>

true if all characters are stricken out; false if no character is stricken out; null if only some characters are stricken out.

Remarks

Use a text span’s Strikeout or a table cell’s CharacterProperties.Strikeout property to identify whether all characters in the span or cell are stricken out. Call the TextSpan.ChangePropertiesAsync or TableCell.ChangePropertiesAsync method to apply/remove the strikeout font attribute to/from characters. The ForegroundColor property defines the color of the line that strikes out characters.

The following example strikes out 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.Strikeout = true;
            });
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
    }
}

Implements

See Also