IAnnotatable IAnnotatable Interface

A class that exposes annotations. Annotations allow for arbitrary metadata to be stored on an object.

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

Syntax

Declaration

public interface IAnnotatablePublic Interface IAnnotatable

Properties summary

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

Methods summary

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

Gets all annotations on the current object.

Properties

  • Item[String]
    Item(String)

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

    object this[string name] { get; }ReadOnly Property Item(name As String) As Object

    Parameters

    • name
      System.String
      System.String

      The key of the annotation to find.

    Property Value

    • System.Object
      System.Object

      The value of the existing annotation if an annotation with the specified name already exists. Otherwise, null.

Methods

  • FindAnnotation(String)
    FindAnnotation(String)

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

    IAnnotation FindAnnotation(string name)Function FindAnnotation(name As String) As IAnnotation

    Parameters

    • name
      System.String
      System.String

      The key of the annotation to find.

    Returns

    • The existing annotation if an annotation with the specified name already exists. Otherwise, null.

  • GetAnnotations()
    GetAnnotations()

    Gets all annotations on the current object.

    IEnumerable<IAnnotation> GetAnnotations()Function GetAnnotations As IEnumerable(Of IAnnotation)

    Returns

    • System.Collections.Generic.IEnumerable<T><IAnnotation>
      System.Collections.Generic.IEnumerable<T>(Of IAnnotation)

Details

Assembly

Microsoft.EntityFrameworkCore.dll