Skip to main content
Tab

ASPxGridSearchPanelSettings.HighlightResults Property

Gets or sets a value that specifies whether the grid highlights the searched texts in the grid.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v21.2.dll

Declaration

[DefaultValue(true)]
public bool HighlightResults { get; set; }

Property Value

Type Default Description
Boolean

true

true, if the grid highlights the searched text; otherwise, false.

Property Paths

You can access this nested property as listed below:

Show 20 property paths
Library Object Type Path to HighlightResults
ASP.NET Bootstrap Controls BootstrapCardView
.SettingsSearchPanel.HighlightResults
BootstrapGridView
.SettingsSearchPanel.HighlightResults
ASP.NET MVC Extensions CardViewSettings
.SettingsSearchPanel.HighlightResults
CardViewSettings<CardType>
.SettingsSearchPanel.HighlightResults
GridViewSettings
.SettingsSearchPanel.HighlightResults
GridViewSettings<RowType>
.SettingsSearchPanel.HighlightResults
MVCxCardView
.SettingsSearchPanel.HighlightResults
MVCxGridView
.SettingsSearchPanel.HighlightResults
MVCxGridViewProperties
.SettingsSearchPanel.HighlightResults
MVCxTreeList
.SettingsSearchPanel.HighlightResults
MVCxVerticalGrid
.SettingsSearchPanel.HighlightResults
TreeListSettings
.SettingsSearchPanel.HighlightResults
TreeListSettings<RowType>
.SettingsSearchPanel.HighlightResults
VerticalGridSettings
.SettingsSearchPanel.HighlightResults
VerticalGridSettings<ColumnType>
.SettingsSearchPanel.HighlightResults
ASP.NET Web Forms Controls ASPxCardView
.SettingsSearchPanel.HighlightResults
ASPxGridView
.SettingsSearchPanel.HighlightResults
ASPxTreeList
.SettingsSearchPanel.HighlightResults
ASPxVerticalGrid
.SettingsSearchPanel.HighlightResults
GridViewProperties
.SettingsSearchPanel.HighlightResults

Remarks

The grid displays the search panel when the ASPxGridSearchPanelSettings.Visible property is set to true. It allows end users to type the required text in the panel editor to filter grid data.

Use the HighlightResults property to specify whether the grid should highlight the searched text.

Note

The grid does not highlight search results contained in templates.

SearchPanel

Example

The following example illustrates how to remove highlighting in the search results.

Web Forms (declaratively):

<dx:ASPxGridView ID="Grid" runat="server" >
    ...
    <SettingsSearchPanel Visible="true" HighlightResults="false" />
</dx:ASPxGridView>

Web Forms (in code):

ASPxGridView grid1 = new ASPxGridView();
grid1.ID = "grid1";
Page.Form.Controls.Add(grid1);
...
grid1.SettingsSearchPanel.Visible = true;
grid1.SettingsSearchPanel.HighlightResults = false;

MVC:

@Html.DevExpress().GridView(settings => {
    settings.Name = "grid";
    settings.SettingsSearchPanel.Visible = true;
    settings.SettingsSearchPanel.HighlightResults = false;    
    ...
}).Bind(Model).GetHtml()

Concept

GridView:

CardView:

VerticalGrid:

TreeList:

Online Demos

GridView:

CardView:

Vertical Grid:

Tree List:

See Also