VerticalGridDataItemTemplateContainer.GetTextWithHighlightedSearchFilterResult(String, String, Boolean, Int32) Method

Gets a result of filtering as an HTML markup where a source text (text inputted in the filter) is highlighted for each match.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v22.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

public string GetTextWithHighlightedSearchFilterResult(
    string sourceText,
    string fieldName,
    bool isSourceTextEncoded,
    int maxLength
)

VB.NET

Public Function GetTextWithHighlightedSearchFilterResult(
    sourceText As String,
    fieldName As String,
    isSourceTextEncoded As Boolean,
    maxLength As Integer
) As String

Parameters

Name	Type	Description
sourceText	String	A string value specifying the filter text criteria.
fieldName	String	A string value specifying the name of a field attached to a row.
isSourceTextEncoded	Boolean	A boolean value that specifies whether the source text is encoded.
maxLength	Int32	An integer value that specifies the maximum length of the received string.

Returns

Type	Description
String	A string value that represents filtering results in the HTML markup.

Remarks

Use the GetTextWithHighlightedSearchFilterResult method to receive a filtering result while a filtered row incorporates a template. Note that the result is received as the HTML markup with the highlighted source text for each match.