RelationalPropertyExtensions.SetComment Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.Relational.dll
Package:
Microsoft.EntityFrameworkCore.Relational v3.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v3.1.0
Package:
Microsoft.EntityFrameworkCore.Relational v5.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v6.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v7.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v8.0.0

Overloads

SetComment(IConventionProperty, String, Boolean)

Configures a comment to be applied to the column this property is mapped to.
SetComment(IMutableProperty, String)

Configures a comment to be applied to the column this property is mapped to.

SetComment(IConventionProperty, String, Boolean)

Configures a comment to be applied to the column this property is mapped to.

public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionProperty property, string comment, bool fromDataAnnotation = false);
public static string SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionProperty property, string comment, bool fromDataAnnotation = false);
public static string? SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionProperty property, string? comment, bool fromDataAnnotation = false);
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IConventionProperty * string * bool -> unit
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IConventionProperty * string * bool -> string
<Extension()>
Public Sub SetComment (property As IConventionProperty, comment As String, Optional fromDataAnnotation As Boolean = false)
<Extension()>
Public Function SetComment (property As IConventionProperty, comment As String, Optional fromDataAnnotation As Boolean = false) As String

Parameters

property
IConventionProperty

The property.

comment
String

The comment for the column.

fromDataAnnotation
Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

String

The configured value.

Applies to

SetComment(IMutableProperty, String)

Configures a comment to be applied to the column this property is mapped to.

public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IMutableProperty property, string comment);
public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IMutableProperty property, string? comment);
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IMutableProperty * string -> unit
<Extension()>
Public Sub SetComment (property As IMutableProperty, comment As String)

Parameters

property
IMutableProperty

The property.

comment
String

The comment for the column.

Applies to