LookUpEditSearchHighlightEventArgs.SetHighlightRanges(Func<String, String, DisplayTextHighlightRange[]>) Method

Sets specific highlight ranges.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void SetHighlightRanges(
    Func<string, string, DisplayTextHighlightRange[]> getRangesFromDisplayTextAndFieldName
)

VB.NET

Public Sub SetHighlightRanges(
    getRangesFromDisplayTextAndFieldName As Func(Of String, String, DisplayTextHighlightRange())
)

Parameters

Name	Type	Description
getRangesFromDisplayTextAndFieldName	Func<String, String, DevExpress.Data.DisplayTextHighlightRange[]>	A function that must return a highlight ranges’ array. A highlight range is a structure that contains the first hightlighted char position, and the length of highlighted charecters’ sequence.

Remarks

The example below illustrates how to highlight all “Ship Country” and “Ship City” field values if they start with a user text.

C#

private void LookUpEdit1_AutoSearch(object sender, LookUpEditAutoSearchEventArgs e)
{
    e.SetAutoSearchParameters(FindPanelParserKind.And, FilterCondition.StartsWith);
    e.SetHighlightRanges(CustomHightlight(e.Text));
}

static Func<string, string, DisplayTextHighlightRange[]> CustomHightlight(string userText)
{
    return (displayText, fieldName) =>
    {
        if (fieldName == "ShipCity" || fieldName == "ShipCountry")
        {
            if (displayText.StartsWith(userText))
                return new DisplayTextHighlightRange[] {
                    new DisplayTextHighlightRange(0, displayText.Length) };
        }
        return null;
    };
}

VB.NET

Private Sub LookUpEdit1_AutoSearch(ByVal sender As Object, ByVal e As LookUpEditAutoSearchEventArgs)
    e.SetAutoSearchParameters(FindPanelParserKind.And, FilterCondition.StartsWith)
    e.SetHighlightRanges(CustomHightlight(e.Text))
End Sub

Shared Function CustomHightlight(ByVal userText As String) As Func(Of String, String, DisplayTextHighlightRange())
    Return Function(displayText, fieldName)
        If fieldName = "ShipCity" OrElse fieldName = "ShipCountry" Then
            If displayText.StartsWith(userText) Then
                Return New DisplayTextHighlightRange() { New DisplayTextHighlightRange(0, displayText.Length) }
            End If
        End If
        Return Nothing
    End Function
End Function