CollectionEntry<TEntity, TProperty> CollectionEntry(Of TEntity, TProperty) Class

Definition

Provides access to change tracking and loading information for a collection navigation property that associates this entity to a collection of another entities.

Instances of this class are returned from methods when using the ChangeTracker API and it is not designed to be directly constructed in your application code.

public class CollectionEntry<TEntity, TProperty> : CollectionEntry, IInfrastructure<InternalEntityEntry> where TEntity : class where TProperty : class
Public Class CollectionEntry(Of TEntity As Class, TProperty As Class)
    Inherits CollectionEntry
    Implements IInfrastructure(Of InternalEntityEntry)
Type Parameters
TEntity

The type of the entity the property belongs to.

TProperty

The type of the property.

Inheritance
System.ObjectSystem.Object
CollectionEntry<TEntity, TProperty>CollectionEntry(Of TEntity, TProperty)
Implements

Constructors

CollectionEntry(InternalEntityEntry, INavigation) CollectionEntry(InternalEntityEntry, INavigation)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public CollectionEntry(InternalEntityEntry internalEntry, INavigation navigation)
Public Sub New(internalEntry As InternalEntityEntry, navigation As INavigation)
Parameters

CollectionEntry(InternalEntityEntry, String) CollectionEntry(InternalEntityEntry, String)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public CollectionEntry(InternalEntityEntry internalEntry, string name)
Public Sub New(internalEntry As InternalEntityEntry, name As String)
Parameters
name
System.String System.String

Properties

CurrentValue CurrentValue

Gets or sets the value currently assigned to this property. If the current value is set using this property, the change tracker is aware of the change and DetectChanges() is not required for the context to detect the change.

public virtual IEnumerable<TProperty> CurrentValue { get; set; }
Public Overridable Property CurrentValue As IEnumerable(Of TProperty)
Value
System.Collections.Generic.IEnumerable<TProperty> System.Collections.Generic.IEnumerable(Of TProperty)

EntityEntry EntityEntry

The EntityEntry<TEntity> to which this member belongs.

public virtual EntityEntry<TEntity> EntityEntry { get; }
Public Overridable ReadOnly Property EntityEntry As EntityEntry(Of TEntity)
Value
EntityEntry<TEntity> EntityEntry(Of TEntity)

An entry for the entity that owns this member.

IInfrastructure.Instance Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure.Instance

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

(Inherited from MemberEntry)

InternalEntry InternalEntry

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

(Inherited from MemberEntry)

IsLoaded IsLoaded

Gets or sets a value indicating whether the entity or entities referenced by this navigation property are known to be loaded.

Loading entities from the database using Include<TEntity, TProperty>(IQueryable<TEntity>, Expression<Func<TEntity, TProperty>>) or ThenInclude<TEntity, TPreviousProperty, TProperty>(IIncludableQueryable<TEntity, IEnumerable<TPreviousProperty>>, Expression<Func<TPreviousProperty, TProperty>>) , Load(), or LoadAsync(CancellationToken) will set this flag. Subseqent calls to Load() or LoadAsync(CancellationToken) will then be a no-op.

It is possible for IsLoaded to be false even if all related entities are loaded. This is because, depending on how entities are loaded, it is not always possible to know for sure that all entities in a related collection have been loaded. In such cases, calling Load() or LoadAsync(CancellationToken) will ensure all related entities are loaded and will set this flag to true.

(Inherited from NavigationEntry)

IsModified IsModified

Gets or sets a value indicating whether any of foreign key property values associated with this navigation property have been modified and should be updated in the database when SaveChanges() is called.

(Inherited from NavigationEntry)

Metadata Metadata

Gets the metadata that describes the facets of this property and how it maps to the database.

(Inherited from NavigationEntry)

Methods

EnsureInitialized() EnsureInitialized()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

(Inherited from CollectionEntry)

Equals(Object) Equals(Object)

Inherited from System.Object

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

Inherited from System.Object

Finder(Type) Finder(Type)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

(Inherited from NavigationEntry)

GetHashCode() GetHashCode()

Inherited from System.Object

GetType() GetType()

Inherited from System.Object

Load() Load()

Loads the entities referenced by this navigation property, unless IsLoaded is already set to true.

Note that entities that are already being tracked are not overwritten with new data from the database.

(Inherited from CollectionEntry)

LoadAsync(CancellationToken) LoadAsync(CancellationToken)

Loads entities referenced by this navigation property, unless IsLoaded is already set to true.

Note that entities that are already being tracked are not overwritten with new data from the database.

Multiple active operations on the same context instance are not supported. Use 'await' to ensure that any asynchronous operations have completed before calling another method on this context.

(Inherited from CollectionEntry)

MemberwiseClone() MemberwiseClone()

Inherited from System.Object

Query() Query()

Returns the query that would be used by Load() to load entities referenced by this navigation property.

The query can be composed over using LINQ to perform filtering, counting, etc. without actually loading all entities from the database.

public virtual IQueryable<TProperty> Query()
Public Overridable Function Query As IQueryable(Of TProperty)
Returns
System.Linq.IQueryable<TProperty> System.Linq.IQueryable(Of TProperty)

ReferenceEquals(Object, Object) ReferenceEquals(Object, Object)

Inherited from System.Object

ToString() ToString()

Inherited from System.Object