Share via


PropertyInterceptionContext<TValue> Class

Definition

Represents contextual information associated with calls to property setters of type TValue.

public class PropertyInterceptionContext<TValue> : System.Data.Entity.Infrastructure.Interception.DbInterceptionContext
type PropertyInterceptionContext<'Value> = class
    inherit DbInterceptionContext
Public Class PropertyInterceptionContext(Of TValue)
Inherits DbInterceptionContext

Type Parameters

TValue

The type of the target property.

Inheritance
PropertyInterceptionContext<TValue>
Derived

Remarks

An instance of this class is passed to the dispatch methods and does not contain mutable information such as the result of the operation. This mutable information is obtained from the PropertyInterceptionContext<TValue> that is passed to the interceptors. Instances of this class are publicly immutable. To add contextual information use one of the With... or As... methods to create a new interception context containing the new information.

Constructors

PropertyInterceptionContext<TValue>()

Constructs a new PropertyInterceptionContext<TValue> with no state.

PropertyInterceptionContext<TValue>(DbInterceptionContext)

Creates a new PropertyInterceptionContext<TValue> by copying immutable state from the given interception context. Also see Clone()

Properties

DbContexts

Gets all the DbContext instances associated with this interception context.

(Inherited from DbInterceptionContext)
Exception

If this property is set before the operation has executed, then execution of the operation will be suppressed and the set exception will be thrown instead. Otherwise, if the operation fails, then this property will be set to the exception that was thrown. In either case, interceptors that run after the operation can change this property to change the exception that will be thrown, or set this property to null to cause no exception to be thrown at all.

IsAsync

True if the operation is being executed asynchronously, otherwise false.

(Inherited from DbInterceptionContext)
IsExecutionSuppressed

When true, this flag indicates that that execution of the operation has been suppressed by one of the interceptors. This can be done before the operation has executed by calling SuppressExecution() or by setting an Exception to be thrown

ObjectContexts

Gets all the ObjectContext instances associated with this interception context.

(Inherited from DbInterceptionContext)
OriginalException

If execution of the operation fails, then this property will contain the exception that was thrown. If the operation was suppressed or did not fail, then this property will always be null.

TaskStatus

Set to the status of the Task after an async operation has finished. Not used for synchronous operations.

UserState
Obsolete.

Gets or sets a value containing arbitrary user-specified state information associated with the operation.

Value

The value that will be assigned to the target property.

Methods

AsAsync()

Creates a new PropertyInterceptionContext<TValue> that contains all the contextual information in this interception context together with the IsAsync flag set to true.

Clone()

Call this method when creating a copy of an interception context in order to add new state to it. Using this method instead of calling the constructor directly ensures virtual dispatch so that the new type will have the same type (and any specialized state) as the context that is being cloned.

Equals(Object)

Determines whether the specified object is equal to the current object.

FindUserState(String)

Gets a value containing arbitrary user-specified state information associated with the operation.

GetHashCode()

Serves as the default hash function.

GetType()

Gets the Type of the current instance.

SetUserState(String, Object)

Sets a value containing arbitrary user-specified state information associated with the operation.

SuppressExecution()

Prevents the operation from being executed if called before the operation has executed.

ToString()

Returns a string that represents the current object.

WithDbContext(DbContext)

Creates a new PropertyInterceptionContext<TValue> that contains all the contextual information in this interception context with the addition of the given ObjectContext.

WithObjectContext(ObjectContext)

Creates a new PropertyInterceptionContext<TValue> that contains all the contextual information in this interception context with the addition of the given ObjectContext.

WithValue(TValue)

Creates a new BeginTransactionInterceptionContext that contains all the contextual information in this interception context together with the given property value.

Applies to