GridViewModel.KeyFieldName Property

Gets or sets the name of the data source key field.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v25.2.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public string KeyFieldName { get; set; }

VB.NET

Public Property KeyFieldName As String

Property Value

Type	Description
String	The name of the data source key field.

Remarks

You must specify KeyFieldName to implement custom data binding in the Grid View extension. Refer to the following topic for additional information: Custom Data Binding.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the KeyFieldName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-mvc-grid-master-detail-and-custom-binding/CS/Example/Controllers/HomeController.cs#L64

var viewModel = new GridViewModel();
viewModel.KeyFieldName = "CustomerID";
viewModel.Columns.Add("ContactName");

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/Controllers/OrdersController.cs#L48

GridViewModel viewModel = new GridViewModel();
viewModel.KeyFieldName = "ID";
viewModel.Columns.Add("ProductName");

asp-net-mvc-grid-custom-binding-with-sorting-paging/CS/Sample/Controllers/HomeController.cs#L40

var viewModel = new GridViewModel();
viewModel.KeyFieldName = "CustomerID";
viewModel.Columns.Add("ContactName");

VB.NET

asp-net-mvc-grid-master-detail-and-custom-binding/VB/Example/Controllers/HomeController.vb#L58

Dim viewModel = New GridViewModel()
viewModel.KeyFieldName = "CustomerID"
viewModel.Columns.Add("ContactName")

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/Controllers/OrdersController.vb#L51

Dim viewModel As New GridViewModel()
viewModel.KeyFieldName = "ID"
viewModel.Columns.Add("ProductName")

asp-net-mvc-grid-custom-binding-with-sorting-paging/VB/Sample/Controllers/HomeController.vb#L36

Dim viewModel = New GridViewModel()
viewModel.KeyFieldName = "CustomerID"
viewModel.Columns.Add("ContactName")