StringPropertyConfiguration.HasColumnAnnotation(String, Object) Method

Reference

Definition

Namespace:: System.Data.Entity.ModelConfiguration.Configuration

Assembly:: EntityFramework.dll

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.

Sets an annotation in the model for the database column used to store the property. The annotation value can later be used when processing the column such as when creating migrations.

public System.Data.Entity.ModelConfiguration.Configuration.StringPropertyConfiguration HasColumnAnnotation (string name, object value);

override this.HasColumnAnnotation : string * obj -> System.Data.Entity.ModelConfiguration.Configuration.StringPropertyConfiguration

Public Function HasColumnAnnotation (name As String, value As Object) As StringPropertyConfiguration

Parameters

name: 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

StringPropertyConfiguration

The same StringPropertyConfiguration 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