XPMemberInfo.IsKey Property

Gets whether the member represents a key member.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v23.2.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public bool IsKey { get; }

VB.NET

Public ReadOnly Property IsKey As Boolean

Property Value

Type	Description
Boolean	true if the member represents a key member; otherwise, false.

Remarks

A key member is a member which uniquely identifies each object instance in the persistent object collection. There can only be one key member in the persistent object collection which is marked by the KeyAttribute.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IsKey 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-clone-a-persistent-object-e804/CS/SimpleObject/CloneHelper.cs#L48

private void CloneProperty(XPMemberInfo memberInfo, object source, object target, bool synchronize) {
    if (memberInfo is DevExpress.Xpo.Metadata.Helpers.ServiceField || memberInfo.IsKey) {
        return;

VB.NET

XPO_how-to-clone-a-persistent-object-e804/VB/SimpleObject/CloneHelper.vb#L51

Private Sub CloneProperty(ByVal memberInfo As XPMemberInfo, ByVal source As Object, ByVal target As Object, ByVal synchronize As Boolean)
    If TypeOf memberInfo Is DevExpress.Xpo.Metadata.Helpers.ServiceField OrElse memberInfo.IsKey Then
        Return