Share via

RelationalPropertyExtensions.GetComment 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

GetComment(IProperty)

Returns the comment for the column this property is mapped to.
GetComment(IReadOnlyProperty)

Returns the comment for the column this property is mapped to.
GetComment(IProperty, StoreObjectIdentifier)

Returns the comment for the column this property is mapped to.
GetComment(IReadOnlyProperty, StoreObjectIdentifier)

Returns the comment for the column this property is mapped to.

GetComment(IProperty)

Returns the comment for the column this property is mapped to.

public static string GetComment (this Microsoft.EntityFrameworkCore.Metadata.IProperty property);
static member GetComment : Microsoft.EntityFrameworkCore.Metadata.IProperty -> string
<Extension()>
Public Function GetComment (property As IProperty) As String

Parameters

property
IProperty

The property.

Returns

String

The comment for the column this property is mapped to.

Applies to

GetComment(IReadOnlyProperty)

Returns the comment for the column this property is mapped to.

public static string? GetComment (this Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty property);
static member GetComment : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty -> string
<Extension()>
Public Function GetComment (property As IReadOnlyProperty) As String

Parameters

property
IReadOnlyProperty

The property.

Returns

String

The comment for the column this property is mapped to.

Applies to

GetComment(IProperty, StoreObjectIdentifier)

Returns the comment for the column this property is mapped to.

public static string GetComment (this Microsoft.EntityFrameworkCore.Metadata.IProperty property, in Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier storeObject);
static member GetComment : Microsoft.EntityFrameworkCore.Metadata.IProperty * StoreObjectIdentifier -> string
<Extension()>
Public Function GetComment (property As IProperty, ByRef storeObject As StoreObjectIdentifier) As String

Parameters

property
IProperty

The property.

storeObject
StoreObjectIdentifier

The identifier of the table-like store object containing the column.

Returns

String

The comment for the column this property is mapped to.

Applies to

GetComment(IReadOnlyProperty, StoreObjectIdentifier)

Returns the comment for the column this property is mapped to.

public static string? GetComment (this Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty property, in Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier storeObject);
static member GetComment : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty * StoreObjectIdentifier -> string
<Extension()>
Public Function GetComment (property As IReadOnlyProperty, ByRef storeObject As StoreObjectIdentifier) As String

Parameters

property
IReadOnlyProperty

The property.

storeObject
StoreObjectIdentifier

The identifier of the table-like store object containing the column.

Returns

String

The comment for the column this property is mapped to.

Applies to