ICharacterProperties.HighlightColor Property

Returns the highlight color of characters.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

Color? HighlightColor { get; }

Property Value

Type	Description
Nullable<Color>	The highlight color or null if at least two different characters use different highlight colors.

Remarks

A cell stores its text formatting settings in the CharacterProperties property. Call the cell’s ChangePropertiesAsync method to change the highlight color of all cell characters.

Note

The highlight color overlaps the background color.

The following example highlights all characters in the first table row in yellow:

<DxRichEdit @ref="richEdit" />

@code {
    DxRichEdit richEdit;
    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 {
            var columnCount = 4;
            var rowCount = 5;
            richEdit.DocumentAPI.BeginUpdate();
            // Creates a table
            Table myTable = await richEdit.DocumentAPI.Tables.CreateAsync(0, columnCount, rowCount);
            for (int i = rowCount-1; i >=0 ; i--)
                for (int j = columnCount-1; j >=0 ; j--) {
                    var cellPosition = myTable.Rows[i].Cells[j].Interval.Start;
                    await richEdit.DocumentAPI.AddTextAsync(cellPosition, "sample text");
                }
            // Customizes the table
            myTable = await richEdit.DocumentAPI.Tables.GetAsync(0);
            var firstRow = myTable.Rows[0];
            foreach (TableCell cell in firstRow.Cells)
                if (cell.CharacterProperties.HighlightColor != System.Drawing.Color.Yellow)
                    await cell.ChangePropertiesAsync(properties => {
                        properties.CharacterProperties.HighlightColor = System.Drawing.Color.Yellow;
                    });
            richEdit.DocumentAPI.EndUpdate();
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
    }
}