ConventionAnnotatableExtensions.SetOrRemoveAnnotation Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.dll
Package:
Microsoft.EntityFrameworkCore v3.0.0
Package:
Microsoft.EntityFrameworkCore v3.1.0
Package:
Microsoft.EntityFrameworkCore v5.0.0

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.

public static void SetOrRemoveAnnotation (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation = false);
public static Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation SetOrRemoveAnnotation (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation = false);
static member SetOrRemoveAnnotation : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * string * obj * bool -> unit
static member SetOrRemoveAnnotation : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * string * obj * bool -> Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation
<Extension()>
Public Sub SetOrRemoveAnnotation (annotatable As IConventionAnnotatable, name As String, value As Object, Optional fromDataAnnotation As Boolean = false)
<Extension()>
Public Function SetOrRemoveAnnotation (annotatable As IConventionAnnotatable, name As String, value As Object, Optional fromDataAnnotation As Boolean = false) As IConventionAnnotation

Parameters

annotatable
IConventionAnnotatable

The object to set the annotation for.

name
String

The name of the annotation to be added.

value
Object

The value to be stored in the annotation.

fromDataAnnotation
Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionAnnotation

The new annotation or null if it was removed.

Applies to