IAnnotatable IAnnotatable Interface

Definition

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.

public interface IAnnotatable
Public Interface IAnnotatable

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.

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<IAnnotation> System.Collections.Generic.IEnumerable(Of IAnnotation)