DataServiceKeyAttribute Class

Denotes the key property or properties of an entity.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Data.Services.Common.DataServiceKeyAttribute

Namespace:  System.Data.Services.Common
Assembly:  Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False)> _
Public NotInheritable Class DataServiceKeyAttribute _
    Inherits Attribute
'Usage
Dim instance As DataServiceKeyAttribute
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false)]
public sealed class DataServiceKeyAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false)]
public ref class DataServiceKeyAttribute sealed : public Attribute
[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false)>]
type DataServiceKeyAttribute =  
    class 
        inherit Attribute 
    end
public final class DataServiceKeyAttribute extends Attribute

The DataServiceKeyAttribute type exposes the following members.

Constructors

  Name Description
Public method DataServiceKeyAttribute(String) Initializes a new instance of the DataServiceKeyAttribute class.
Public method DataServiceKeyAttribute(array<String[]) Initializes a new instance of the DataServiceKeyAttribute class.

Top

Properties

  Name Description
Public property KeyNames Gets the names of key attributes.
Public property TypeId (Inherited from Attribute.)

Top

Methods

  Name Description
Public method Equals (Inherited from Attribute.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke (Inherited from Attribute.)

Top

Remarks

You should only apply the DataServiceKeyAttribute attribute to a property that can be used to uniquely identify an instance of the entity type. This attribute is ignored when applied to a navigation property. For more information, see Reflection Provider (WCF Data Services).

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Data.Services.Common Namespace