RuntimeAnnotatableBase Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Infrastructure

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v9.0.0

Source:: RuntimeAnnotatableBase.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for types that support reading and writing annotations.

This type is typically used by database providers (and other extensions). It is generally not used in application code.

public class RuntimeAnnotatableBase : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable

type RuntimeAnnotatableBase = class
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Class RuntimeAnnotatableBase
Implements IAnnotatable

Inheritance: Object
RuntimeAnnotatableBase

Derived: Microsoft.EntityFrameworkCore.Metadata.RuntimeElementType

Microsoft.EntityFrameworkCore.Metadata.RuntimeForeignKey

Microsoft.EntityFrameworkCore.Metadata.RuntimeIndex

Microsoft.EntityFrameworkCore.Metadata.RuntimeKey

Microsoft.EntityFrameworkCore.Metadata.RuntimeModel

More…

Implements: IAnnotatable IReadOnlyAnnotatable

Remarks

See Implementation of database providers and extensions for more information and examples.

Constructors

RuntimeAnnotatableBase()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

Properties

Item[String]

Gets the value annotation with the given name, returning null if it does not exist.

Methods

AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists.
AddAnnotations(IEnumerable<IAnnotation>)	Adds annotations to this object overriding any existing annotations with the same name.
AddAnnotations(IReadOnlyDictionary<String,Object>)	Adds annotations to this object overriding any existing annotations with the same name.
AddRuntimeAnnotation(String, Annotation)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.
AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.
AddRuntimeAnnotations(IEnumerable<Annotation>)	Adds runtime annotations to this object.
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)	Adds runtime annotations to this object.
CreateAnnotation(String, Object)	Creates a new annotation.
CreateRuntimeAnnotation(String, Object)	Creates a new runtime annotation.
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist.
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning `null` if it does not exist.
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist.
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Gets the value of the runtime annotation with the given name, adding it if one does not exist.
GetRuntimeAnnotations()	Gets all runtime annotations on the current object.
RemoveAnnotation(String)	Removes the given annotation from this object.
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object.
SetAnnotation(String, Object)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
SetRuntimeAnnotation(String, Annotation, Annotation)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.

Explicit Interface Implementations

IAnnotatable.AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.
IAnnotatable.FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning `null` if it does not exist.
IAnnotatable.GetRuntimeAnnotations()	Gets all the runtime annotations on the current object.
IAnnotatable.RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object.
IAnnotatable.SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
IReadOnlyAnnotatable.FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist.
IReadOnlyAnnotatable.GetAnnotations()	Gets all annotations on the current object.
IReadOnlyAnnotatable.Item[String]	Gets the value of the annotation with the given name, returning `null` if it does not exist.

Applies to

Partager via