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.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

Простой ключ EntityKey, определяющий сущность, полученную после неудачной операции TREAT.A simple EntityKey identifying an entity that resulted from a failed TREAT operation.

NoEntitySetKey NoEntitySetKey NoEntitySetKey NoEntitySetKey

Одноэлементный ключ EntityKey, по которому определяется сущность, доступная только для чтения.A 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)

Сравнивает два объекта EntityKey.Compares two EntityKey objects.

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

Сравнивает два объекта EntityKey.Compares two EntityKey objects.

Применяется к