XPClassInfo.KeyProperty Property

Gets information on the key property or key field.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public XPMemberInfo KeyProperty { get; }

VB.NET

Public ReadOnly Property KeyProperty As XPMemberInfo

Property Value

Type	Description
XPMemberInfo	An XPMemberInfo object which provides information about the key property or key field. If null (Nothing in Visual Basic) a KeyPropertyAbsentException is thrown.

Remarks

Use this property to retrieve information on the member which provides key values for unique identification of the persistent objects within the collection.

See the Microsoft .NET Framework Documentation and Microsoft SQL Server Guide in order to learn more about relational databases.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the KeyProperty 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#

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/App_Start/WebApiConfig.cs#L79

} else {
    if(classInfo.KeyProperty is ReflectionFieldInfo) {
        foreach(XPMemberInfo mi in classInfo.Members) {