Share via


ForeignKeyAssociationMappingConfiguration.HasColumnAnnotation Method

Definition

Sets an annotation in the model for a database column that has been configured with MapKey(String[]). The annotation value can later be used when processing the column such as when creating migrations.

public System.Data.Entity.ModelConfiguration.Configuration.ForeignKeyAssociationMappingConfiguration HasColumnAnnotation (string keyColumnName, string annotationName, object value);
member this.HasColumnAnnotation : string * string * obj -> System.Data.Entity.ModelConfiguration.Configuration.ForeignKeyAssociationMappingConfiguration
Public Function HasColumnAnnotation (keyColumnName As String, annotationName As String, value As Object) As ForeignKeyAssociationMappingConfiguration

Parameters

keyColumnName
String

The name of the column that was configured with the HasKey method.

annotationName
String

The annotation name, which must be a valid C#/EDM identifier.

value
Object

The annotation value, which may be a string or some other type that can be serialized with an IMetadataAnnotationSerializer

Returns

The same ForeignKeyAssociationMappingConfiguration instance so that multiple calls can be chained.

Remarks

It will likely be necessary to register a IMetadataAnnotationSerializer if the type of the annotation value is anything other than a string. Passing a null value clears any annotation with the given name on the column that had been previously set.

Applies to