EntityKey EntityKey EntityKey EntityKey Class

定義

エンティティ型のインスタンスであるオブジェクトへの持続的な参照を提供します。Provides a durable reference to an object that is an instance of an entity type.

public ref class EntityKey sealed : IEquatable<System::Data::EntityKey ^>
[System.Runtime.Serialization.DataContract(IsReference=true)]
[System.Serializable]
public sealed class EntityKey : IEquatable<System.Data.EntityKey>
type EntityKey = class
    interface IEquatable<EntityKey>
Public NotInheritable Class EntityKey
Implements IEquatable(Of EntityKey)
継承
EntityKeyEntityKeyEntityKeyEntityKey
属性
実装

これらの例がに基づいて、 AdventureWorks Sales Modelします。These examples are based on the AdventureWorks Sales Model. 作成および使用する方法の例に示します、EntityKeyします。The examples show you how to create and use an EntityKey.

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    Object entity = null;
    IEnumerable<KeyValuePair<string, object>> entityKeyValues =
        new KeyValuePair<string, object>[] {
            new KeyValuePair<string, object>("SalesOrderID", 43680) };

    // Create the  key for a specific SalesOrderHeader object. 
    EntityKey key = new EntityKey("AdventureWorksEntities.SalesOrderHeaders", entityKeyValues);

    // Get the object from the context or the persisted store by its key.
    if (context.TryGetObjectByKey(key, out entity))
    {
        Console.WriteLine("The requested " + entity.GetType().FullName +
            " object was found");
    }
    else
    {
        Console.WriteLine("An object with this key " +
            "could not be found.");
    }
}
Using context As New AdventureWorksEntities()
    Dim entity As Object = Nothing
    Dim entityKeyValues As IEnumerable(Of KeyValuePair(Of String, Object)) = _
        New KeyValuePair(Of String, Object)() {New KeyValuePair(Of String, Object)("SalesOrderID", 43680)}

    ' Create the key for a specific SalesOrderHeader object. 
    Dim key As New EntityKey("AdventureWorksEntities.SalesOrderHeaders", entityKeyValues)

    ' Get the object from the context or the persisted store by its key. 
    If context.TryGetObjectByKey(key, entity) Then
        Console.WriteLine("The requested " & entity.GetType().FullName & " object was found")
    Else
        Console.WriteLine("An object with this key could not be found.")
    End If
End Using
using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    try
    {
        // Create the key that represents the order.
        EntityKey orderKey =
            new EntityKey("AdventureWorksEntities.SalesOrderHeaders",
                "SalesOrderID", orderId);

        // Create the stand-in SalesOrderHeader object
        // based on the specified SalesOrderID.
        SalesOrderHeader order = new SalesOrderHeader();
        order.EntityKey = orderKey;

        // Assign the ID to the SalesOrderID property to matche the key.
        order.SalesOrderID = (int)orderKey.EntityKeyValues[0].Value;

        // Attach the stand-in SalesOrderHeader object.
        context.SalesOrderHeaders.Attach(order);

        // Create a new SalesOrderDetail object.
        // You can use the static CreateObjectName method (the Entity Framework
        // adds this method to the generated entity types) instead of the new operator:
        // SalesOrderDetail.CreateSalesOrderDetail(1, 0, 2, 750, 1, (decimal)2171.2942, 0, 0,
        //                                         Guid.NewGuid(), DateTime.Today));
        SalesOrderDetail detail = new SalesOrderDetail
        {
            SalesOrderID = orderId,
            SalesOrderDetailID = 0,
            OrderQty = 2,
            ProductID = 750,
            SpecialOfferID = 1,
            UnitPrice = (decimal)2171.2942,
            UnitPriceDiscount = 0,
            LineTotal = 0,
            rowguid = Guid.NewGuid(),
            ModifiedDate = DateTime.Now
        };

        order.SalesOrderDetails.Add(detail);

        context.SaveChanges();
    }
    catch (InvalidOperationException)
    {
        Console.WriteLine("Ensure that the key value matches the value of the object's ID property.");
    }
    catch (UpdateException)
    {
        Console.WriteLine("An error has occurred. Ensure that an object with the '{0}' key value exists.",
        orderId);
    }
}
Using context As New AdventureWorksEntities()
    Try
        ' Create the key that represents the order. 
        Dim orderKey As New EntityKey("AdventureWorksEntities.SalesOrderHeaders", "SalesOrderID", orderId)

        ' Create the stand-in SalesOrderHeader object 
        ' based on the specified SalesOrderID. 
        Dim order As New SalesOrderHeader()
        order.EntityKey = orderKey

        ' Assign the ID to the SalesOrderID property to matche the key. 
        order.SalesOrderID = CInt(orderKey.EntityKeyValues(0).Value)

        ' Attach the stand-in SalesOrderHeader object. 
        context.SalesOrderHeaders.Attach(order)

        ' Create a new SalesOrderDetail object. 
        ' You can use the static CreateObjectName method (the Entity Framework 
        ' adds this method to the generated entity types) instead of the new operator: 
        ' SalesOrderDetail.CreateSalesOrderDetail(1, 0, 2, 750, 1, (decimal)2171.2942, 0, 0, 
        ' Guid.NewGuid(), DateTime.Today)); 
        Dim detail = New SalesOrderDetail With
        {
            .SalesOrderID = 0,
            .SalesOrderDetailID = 0,
            .OrderQty = 2,
            .ProductID = 750,
            .SpecialOfferID = 1,
            .UnitPrice = CDec(2171.2942),
            .UnitPriceDiscount = 0,
            .LineTotal = 0,
            .rowguid = Guid.NewGuid(),
            .ModifiedDate = DateTime.Now
        }

        order.SalesOrderDetails.Add(detail)

        context.SaveChanges()
    Catch generatedExceptionName As InvalidOperationException
        Console.WriteLine("Ensure that the key value matches the value of the object's ID property.")
    Catch generatedExceptionName As UpdateException
        Console.WriteLine("An error has occurred. Ensure that an object with the '{0}' key value exists.", orderId)
    End Try
End Using

注釈

EntityKey オブジェクトは不変です。つまり、構築後は変更できません。The EntityKey objects are immutable; that is, after they are constructed they cannot be modified.

詳細については、次を参照してください。エンティティ キーの使用します。For more information, see Working with Entity Keys.

コンストラクター

EntityKey() EntityKey() EntityKey() EntityKey()

EntityKey クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityKey class.

EntityKey(String, IEnumerable<EntityKeyMember>) EntityKey(String, IEnumerable<EntityKeyMember>) EntityKey(String, IEnumerable<EntityKeyMember>) EntityKey(String, IEnumerable<EntityKeyMember>)

エンティティ セット名および EntityKey オブジェクトの IEnumerable<T> コレクションを使用して、EntityKeyMember クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityKey class with an entity set name and an IEnumerable<T> collection of EntityKeyMember objects.

EntityKey(String, IEnumerable<KeyValuePair<String,Object>>) EntityKey(String, IEnumerable<KeyValuePair<String,Object>>) EntityKey(String, IEnumerable<KeyValuePair<String,Object>>) EntityKey(String, IEnumerable<KeyValuePair<String,Object>>)

エンティティ セット名およびジェネリック型の EntityKey コレクションを使用して、KeyValuePair クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityKey class with an entity set name and a generic KeyValuePair collection.

EntityKey(String, String, Object) EntityKey(String, String, Object) EntityKey(String, String, Object) EntityKey(String, String, Object)

エンティティ セット名および特定のエンティティ キーのペアを使用して、EntityKey クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityKey class with an entity set name and specific entity key pair.

フィールド

EntityNotValidKey EntityNotValidKey EntityNotValidKey EntityNotValidKey

失敗した TREAT 演算で生成されたエンティティを識別する単純な EntityKeyA simple EntityKey identifying an entity that resulted from a failed TREAT operation.

NoEntitySetKey NoEntitySetKey NoEntitySetKey NoEntitySetKey

読み取り専用エンティティを識別する単一の EntityKeyA singleton EntityKey by which a read-only entity is identified.

プロパティ

EntityContainerName EntityContainerName EntityContainerName EntityContainerName

エンティティ コンテナーの名前を取得または設定します。Gets or sets the name of the entity container.

EntityKeyValues EntityKeyValues EntityKeyValues EntityKeyValues

この EntityKey に関連付けられているキーの値を取得または設定します。Gets or sets the key values associated with this EntityKey.

EntitySetName EntitySetName EntitySetName EntitySetName

エンティティ セットの名前を取得または設定します。Gets or sets the name of the entity set.

IsTemporary IsTemporary IsTemporary IsTemporary

EntityKey が一時的かどうかを示す値を取得します。Gets a value that indicates whether the EntityKey is temporary.

メソッド

Equals(EntityKey) Equals(EntityKey) Equals(EntityKey) Equals(EntityKey)

このインスタンスが、指定された EntityKey と等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified EntityKey.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

GetEntitySet(MetadataWorkspace) GetEntitySet(MetadataWorkspace) GetEntitySet(MetadataWorkspace) GetEntitySet(MetadataWorkspace)

このエンティティ キーのエンティティ セットを、指定されたメタデータ ワークスペースから取得します。Gets the entity set for this entity key from the given metadata workspace.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

現在の EntityKey オブジェクトのハッシュ関数として機能します。Serves as a hash function for the current EntityKey object. GetHashCode() は、ハッシュ アルゴリズムでの使用、およびハッシュ テーブルのようなデータ構造での使用に適しています。GetHashCode() is suitable for hashing algorithms and data structures such as a hash table.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserialized(StreamingContext) OnDeserialized(StreamingContext) OnDeserialized(StreamingContext) OnDeserialized(StreamingContext)

EntityKey のシリアル化解除に使用されるヘルパー メソッド。Helper method that is used to deserialize an EntityKey.

OnDeserializing(StreamingContext) OnDeserializing(StreamingContext) OnDeserializing(StreamingContext) OnDeserializing(StreamingContext)

EntityKey のシリアル化解除に使用されるヘルパー メソッド。Helper method that is used to deserialize an EntityKey.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

演算子

Equality(EntityKey, EntityKey) Equality(EntityKey, EntityKey) Equality(EntityKey, EntityKey) Equality(EntityKey, EntityKey)

2 つの EntityKey オブジェクトを比較します。Compares two EntityKey objects.

Inequality(EntityKey, EntityKey) Inequality(EntityKey, EntityKey) Inequality(EntityKey, EntityKey) Inequality(EntityKey, EntityKey)

2 つの EntityKey オブジェクトを比較します。Compares two EntityKey objects.

適用対象