RelationalEntityTypeExtensions.SetComment Method
Definition
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.
Overloads
SetComment(IMutableEntityType, String) |
Configures a comment to be applied to the table this entity is mapped to. |
SetComment(IConventionEntityType, String, Boolean) |
Configures a comment to be applied to the table this entity is mapped to. |
SetComment(IMutableEntityType, String)
Configures a comment to be applied to the table this entity is mapped to.
public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType entityType, string comment);
public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType entityType, string? comment);
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType * string -> unit
<Extension()>
Public Sub SetComment (entityType As IMutableEntityType, comment As String)
Parameters
- entityType
- IMutableEntityType
The entity type.
- comment
- String
The comment for the table this entity is mapped to.
Applies to
SetComment(IConventionEntityType, String, Boolean)
Configures a comment to be applied to the table this entity is mapped to.
public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType entityType, string comment, bool fromDataAnnotation = false);
public static string SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType entityType, string comment, bool fromDataAnnotation = false);
public static string? SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType entityType, string? comment, bool fromDataAnnotation = false);
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType * string * bool -> unit
static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType * string * bool -> string
<Extension()>
Public Sub SetComment (entityType As IConventionEntityType, comment As String, Optional fromDataAnnotation As Boolean = false)
<Extension()>
Public Function SetComment (entityType As IConventionEntityType, comment As String, Optional fromDataAnnotation As Boolean = false) As String
Parameters
- entityType
- IConventionEntityType
The entity type.
- comment
- String
The comment for the table.
- fromDataAnnotation
- Boolean
Indicates whether the configuration was specified using a data annotation.
Returns
The configured comment.
Applies to
Entity Framework