The requested page is not available for the requested platform. You are viewing the content for Default platform.

ICellCustomizer.HighlightColor Property

Specifies the color used to highlight the cell content in custom user scenarios.

Namespace: DevExpress.Mobile.DataGrid.Theme

Assembly: DevExpress.Mobile.Grid.v18.2.dll

Declaration

Color HighlightColor { get; set; }
Property HighlightColor As Color

Property Value

Type Description
Xamarin.Forms.Color

A Xamarin.Forms.Color object specifying the color.

Remarks

Important

This documentation topic describes legacy technology. We no longer develop new functionality for the GridControl and suggest that you use the new DataGridView control instead.

Examples

This example demonstrates how to implement searching against grid columns - an end-user types in text in a search bar and all cells containing the entered string are highlighted on the fly.

Grid_Search

To implement this functionality, follow the steps below.

  1. Place the SearchBar Xamarin.Forms standard view above the GridControl on the page.
  2. Subscribe to the SearchBar.TextChanged event that is raised each time the text in the search bar is changed. In this event handler, get the currently entered search string and call the GridControl.Redraw method to recalculate the graphical information of the grid.
  3. Before grid cells are repainted, the GridControl.CustomizeCell event is raised. Handle this event to apply the ICellCustomizer.HighlightColor color to cells containing the string currently entered in the search bar.
using System;
using System.Collections.Generic;
using Xamarin.Forms;

using DevExpress.Mobile.DataGrid;
using DevExpress.Mobile.DataGrid.Theme;

namespace GridSearchTextSample {
    public partial class MainPage : ContentPage {

        string searchText;

        public MainPage () {
            InitializeComponent ();

            TestOrdersRepository model = new TestOrdersRepository ();
            BindingContext = model;

            searchText = string.Empty;
        }

        void OnCustomizeCell(CustomizeCellEventArgs e) {
            if (string.IsNullOrEmpty(searchText))
                return;
            string cellText = e.DisplayText.ToUpper();
            if (cellText.Contains(searchText.ToUpper()) && !e.IsSelected) {
                e.BackgroundColor = ThemeManager.Theme.CellCustomizer.HighlightColor;
                e.ForeColor = Color.Black;
                e.Handled = true;
            }
        }
        void OnSearchTextChanged(object sender, EventArgs args) {
            SearchBar searchBar = (SearchBar)sender;
            searchText = searchBar.Text;
            grid.Redraw(false);
        }
    }
}

See Also