Annotatable Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Infrastructure

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v1.0.6

Package:: Microsoft.EntityFrameworkCore v1.1.6

Package:: Microsoft.EntityFrameworkCore v2.0.3

Package:: Microsoft.EntityFrameworkCore v2.1.11

Package:: Microsoft.EntityFrameworkCore v2.2.6

Package:: Microsoft.EntityFrameworkCore v3.0.0

Package:: Microsoft.EntityFrameworkCore v3.1.0

Package:: Microsoft.EntityFrameworkCore v5.0.0

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

Package:: Microsoft.EntityFrameworkCore v9.0.0

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.cs

Source:: Annotatable.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 Annotatable : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable

public class Annotatable : Microsoft.EntityFrameworkCore.Infrastructure.AnnotatableBase, Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable

type Annotatable = class
    interface IMutableAnnotatable
    interface IAnnotatable

type Annotatable = class
    inherit AnnotatableBase
    interface IMutableAnnotatable
    interface IReadOnlyAnnotatable

Public Class Annotatable
Implements IMutableAnnotatable

Public Class Annotatable
Inherits AnnotatableBase
Implements IMutableAnnotatable

Inheritance: Object
Annotatable

Inheritance: Object

AnnotatableBase
Annotatable

Derived: Microsoft.EntityFrameworkCore.Infrastructure.ConventionAnnotatable

Microsoft.EntityFrameworkCore.Migrations.Operations.MigrationOperation

Microsoft.EntityFrameworkCore.Scaffolding.Metadata.ColumnModel

Microsoft.EntityFrameworkCore.Scaffolding.Metadata.DatabaseColumn

Microsoft.EntityFrameworkCore.Scaffolding.Metadata.DatabaseForeignKey

More…

Implements: IAnnotatable IMutableAnnotatable IReadOnlyAnnotatable

Remarks

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

Constructors

Annotatable()

Properties

IsReadOnly	Indicates whether the current object is read-only. (Inherited from AnnotatableBase)
Item[String]	Gets the value annotation with the given name, returning `null` if it does not exist.
Item[String]	Gets the value annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)

Methods

AddAnnotation(String, Annotation)	Adds an annotation to this object. Throws if an annotation with the specified name already exists.
AddAnnotation(String, Annotation)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists.
AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddAnnotations(IEnumerable<IAnnotation>)	Adds annotations to this object. (Inherited from AnnotatableBase)
AddAnnotations(IReadOnlyDictionary<String,Object>)	Adds annotations to this object. (Inherited from AnnotatableBase)
AddRuntimeAnnotation(String, Annotation)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddRuntimeAnnotations(IEnumerable<Annotation>)	Adds runtime annotations to this object. (Inherited from AnnotatableBase)
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)	Adds runtime annotations to this object. (Inherited from AnnotatableBase)
CreateAnnotation(String, Object)	Creates a new annotation.
CreateAnnotation(String, Object)	Creates a new annotation. (Inherited from AnnotatableBase)
CreateRuntimeAnnotation(String, Object)	Creates a new runtime annotation. (Inherited from AnnotatableBase)
EnsureMutable()	Throws if the model is read-only.
EnsureReadOnly()	Throws if the model is not read-only.
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist.
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from AnnotatableBase)
GetAnnotations()	Gets all annotations on the current object.
GetAnnotations()	Gets all annotations on the current object. (Inherited from AnnotatableBase)
GetOrAddAnnotation(String, Object)	Adds an annotation to this object or returns the existing annotation if one with the specified name already exists.
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. (Inherited from AnnotatableBase)
GetRuntimeAnnotations()	Gets all runtime annotations on the current object. (Inherited from AnnotatableBase)
OnAnnotationSet(String, Annotation, Annotation)	Called when an annotation was set or removed.
OnAnnotationSet(String, Annotation, Annotation)	Called when an annotation was set or removed. (Inherited from AnnotatableBase)
RemoveAnnotation(String)	Removes the given annotation from this object.
RemoveAnnotation(String)	Removes the given annotation from this object. (Inherited from AnnotatableBase)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from AnnotatableBase)
SetAnnotation(String, Annotation, Annotation)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
SetAnnotation(String, Annotation, Annotation)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
SetAnnotation(String, Annotation)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
SetAnnotation(String, Object)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.
SetAnnotation(String, Object)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
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. (Inherited from AnnotatableBase)
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. (Inherited from AnnotatableBase)

Explicit Interface Implementations

IAnnotatable.AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
IAnnotatable.FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist.
IAnnotatable.FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)
IAnnotatable.GetAnnotations()	Gets all annotations on the current object.
IAnnotatable.GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from AnnotatableBase)
IAnnotatable.RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from AnnotatableBase)
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. (Inherited from AnnotatableBase)
IMutableAnnotatable.AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists.
IMutableAnnotatable.RemoveAnnotation(String)	Removes the given annotation from this object.
IMutableAnnotatable.SetOrRemoveAnnotation(String, Object)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if `null` is supplied.
IReadOnlyAnnotatable.FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)
IReadOnlyAnnotatable.GetAnnotations()	Gets all annotations on the current object. (Inherited from AnnotatableBase)
IReadOnlyAnnotatable.Item[String]	Gets the value of the annotation with the given name, returning `null` if it does not exist. (Inherited from AnnotatableBase)

Extension Methods

AnnotationsToDebugString(IAnnotatable, Int32)	Gets the debug string for all annotations declared on the object.
GetAnnotation(IAnnotatable, String)	Gets the annotation with the given name, throwing if it does not exist.
AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)	Adds annotations to an object.
GetAnnotation(IMutableAnnotatable, String)	Gets the annotation with the given name, throwing if it does not exist.
GetOrAddAnnotation(IMutableAnnotatable, String, String)	Gets the existing annotation with a given key, or adds a new annotation if one does not exist.
SetOrRemoveAnnotation(IMutableAnnotatable, String, Object)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if `null` is supplied.

Applies to

Dela via