GridSettingsBase.KeyFieldName Property

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

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.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	A String value that specifies the name of the data source key field.

Remarks

The KeyFieldName property should be specified when using the following GridView extension features:

• data editing;
• adding new and deleting existing rows;
• selecting rows;
• master-detail view;
• endless paging.

Limitations

• Key field values must be unique.
• Complex type key values are not allowed. Refer to the following topic for more information: The control cannot serialize complex primary key field values.
• It is not possible to use the edit form to update a key field value.

The GridSettingsBase property supports a composite KeyFieldName property value. You can use semicolon-separated values to specify multi-field keys, for example:

Razor

@Html.DevExpress().GridView(
    settings => {
        settings.KeyFieldName = "id1;id2";
...

C#

...
protected Action DeletePartial(int id1, int id2)
....

Example

Razor(View)

@Html.DevExpress().GridView(settings => {
    settings.Name = "gvDataBindingToLinq";
    settings.CallbackRouteValues = new { Controller = "DataBinding", Action = "DataBindingToLargeDatabasePartial" };
    settings.KeyFieldName = "ID";
    ...
}).BindToEF(string.Empty, string.Empty, (s, e) => {
    e.QueryableSource = LargeDatabaseDataProvider.DB.Emails;
}).GetHtml()

Online Demo

• GridView - Binding to Large Database (Server Mode)

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-export-multiple-gridviews-into-a-document/CS/Controllers/HomeController.cs#L28

categoriesGridSettings.Name = "gvCategories";
categoriesGridSettings.KeyFieldName = "CategoryID";
categoriesGridSettings.Columns.Add("CategoryID");

mvc-gridview-export-data-to-different-formats/CS/Controllers/HomeController.cs#L59

settings.KeyFieldName = "ID";
settings.Settings.ShowFilterRow = true;

asp-net-mvc-grid-export-hide-and-add-columns/CS/E4915/Controllers/HomeController.cs#L36

settings.KeyFieldName = "ProductID";
settings.Columns.Add("ProductID");

asp-net-mvc-grid-export-colored-grid-in-wysiwyg-mode/CS/Controllers/HomeController.cs#L47

settings.KeyFieldName = "ProductID";
settings.Settings.ShowFilterRow = true;

asp-net-mvc-grid-export-colored-grid-in-data-aware-mode/CS/Controllers/HomeController.cs#L57

settings.KeyFieldName = "ProductID";
settings.Settings.ShowFilterRow = true;

VB.NET

asp-net-mvc-grid-export-multiple-gridviews-into-a-document/VB/Controllers/HomeController.vb#L33

categoriesGridSettings.Name = "gvCategories"
categoriesGridSettings.KeyFieldName = "CategoryID"
categoriesGridSettings.Columns.Add("CategoryID")

mvc-gridview-export-data-to-different-formats/VB/Controllers/HomeController.vb#L54

settings.CallbackRouteValues = New With {.Controller = "Home", .Action = "TypedListDataBindingPartial"}
settings.KeyFieldName = "ID"
settings.Settings.ShowFilterRow = True

asp-net-mvc-grid-export-hide-and-add-columns/VB/E4915/Controllers/HomeController.vb#L37

settings.KeyFieldName = "ProductID"

asp-net-mvc-grid-export-colored-grid-in-wysiwyg-mode/VB/Controllers/HomeController.vb#L54

settings.KeyFieldName = "ProductID"
settings.Settings.ShowFilterRow = True

asp-net-mvc-grid-export-colored-grid-in-data-aware-mode/VB/Controllers/HomeController.vb#L66

settings.KeyFieldName = "ProductID"
settings.Settings.ShowFilterRow = True