ASPxGridLookup.KeyFieldName Property

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

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue("")]
public string KeyFieldName { get; set; }

VB.NET

<DefaultValue("")>
Public Property KeyFieldName As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the name of the data source key field.

Remarks

Setting this property is required for the editor to properly process item selection, sorting, paging, and other operations.

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-web-forms-grid-lookup-access-selected-data/CS/ASPxGridLookUpSelection/ServerSide_MultiSelect.aspx.cs#L36

    //Starting with version 16.1.6
    valuesToSelect.Add((int)grid.GetRowValues(i, ASPxGridLookup1.KeyFieldName));
}

VB.NET

asp-net-web-forms-grid-lookup-access-selected-data/VB/ASPxGridLookUpSelection/ServerSide_MultiSelect.aspx.vb#L39

    'Starting with version 16.1.6
    valuesToSelect.Add(CInt((grid.GetRowValues(i, ASPxGridLookup1.KeyFieldName))))
End If