DxDataGrid<T>.KeyFieldName Property

Specifies the key data field’s name.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v22.1.dll

Declaration

[Parameter]
public string KeyFieldName { get; set; }

Property Value

Type	Description
String	The key field’s name.

Remarks

Important

The Data Grid was moved to maintenance support mode. No new features/capabilities will be added to this component. We recommend that you migrate to the Grid component.

The Data Grid should be able to identify individual data items when users edit data, select data rows, or expand detail rows in master-detail layouts.

You can specify the key data field in one of the following ways:

• Define the Data Grid’s KeyFieldName property explicitly.

  Razor

  @using System.Threading
  @inject WeatherForecastService WeatherForecastService
  
  <DxDataGrid DataAsync="@LoadDataAsync" KeyFieldName="Id">
      @*...*@
  </DxDataGrid>
  
  @code {
      async Task<IEnumerable<WeatherForecast>> LoadDataAsync(CancellationToken token) {
          return await WeatherForecastService.GetForecastAsync(DateTime.Now.Date);
      }
  }
  

  WeatherForecast

  using System;
  using System.ComponentModel.DataAnnotations;
  
  public class WeatherForecast {
      public int Id { get; set; }
      public DateTime Date { get; set; }
      public int TemperatureC { get; set; }
      public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
      public string Summary { get; set; }
  }
  

  WeatherForecastService

  using System;
  using System.Linq;
  using System.Threading;
  using System.Threading.Tasks;
  
  public class WeatherForecastService {
      private static readonly string[] Summaries = new[] {
          "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
      };
  
      public Task<WeatherForecast[]> GetForecastAsync(DateTime startDate) => GetForecastAsync(startDate, CancellationToken.None);
      public async Task<WeatherForecast[]> GetForecastAsync(DateTime startDate, CancellationToken token) {
          await Task.Delay(1000, token);
          var rng = new Random();
          return Enumerable.Range(1, 5).Select(index => new WeatherForecast {
              Id = index,
              Date = startDate.AddDays(index),
              TemperatureC = rng.Next(-20, 30),
              Summary = Summaries[rng.Next(Summaries.Length)]
          }).ToArray();
      }
  }
  

  Program.cs

  // ...
  builder.Services.AddSingleton<WeatherForecastService>();
  

• Mark the key data field with the Key attribute in a data collection. Note the KeyFieldName property takes priority over this attribute.

  WeatherForecast

  using System;
  using System.ComponentModel.DataAnnotations;
  
  public class WeatherForecast {
      [Key]
      public int Id { get; set; }
      public DateTime Date { get; set; }
      public int TemperatureC { get; set; }
      public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
      public string Summary { get; set; }
  }
  

• Use the CustomData property and the PrimaryKey array to specify multiple key fields:

  <DxDataGrid T="@WebApiOrder" CustomData="@LoadCustomData">
      @* ... *@
  </DxDataGrid>
  @code {
      IQueryable<WebApiOrder> _data;
      protected Task<LoadResult> LoadCustomData(DataSourceLoadOptionsBase options, CancellationToken cancellationToken)
      {
          @* ... *@
          options.PrimaryKey = new[] { "Key1", "Key2" };
          return DataSourceLoader.LoadAsync(_data, options, cancellationToken);
      }
  }
  

Note

The key field’s values should be unique.

If you do not specify the key field name, the standard Equals method is used to compare data items.

Run Demo: Data Grid - Multiple Selection with Optimized Performance