Share via


IsBuiltInColumn Method

Helper to determine if a column is marked as a built in database column.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Shared Function IsBuiltInColumn ( _
    columnName As String _
) As Boolean
'Usage
Dim columnName As String
Dim returnValue As Boolean

returnValue = CatalogsDataSetSchema.IsBuiltInColumn(columnName)
public static bool IsBuiltInColumn(
    string columnName
)
public:
static bool IsBuiltInColumn(
    String^ columnName
)
public static function IsBuiltInColumn(
    columnName : String
) : boolean

Parameters

Return Value

Type: System..::.Boolean
true to indicate columnName is a built in column; otherwise, false.

Remarks

Used to determine if a column is marked as a built in the Catalogs database column.

This method does not report a built in column at the catalog system level.

For example;

CatalogsDataSetSchema.IsBuiltInColumn("CatalogFlags") will return true since "CatalogFlags" is a built in property in the CatalogsDataSet.

However, CatalogPropertiesDataSetSchema.IsBuiltInColumn("CatalogFlags") will return false since "CatalogFlags" is not a build in property in the CatalogPropertiesDataSet.

The following catalog database columns in the Catalogs table are marked built in:

  • CatalogFlags

  • CatalogId

  • CatalogName

  • CatalogStatus

  • Currency

  • CustomCatalog

  • DefaultLanguage

  • DisplayName

  • EndDate

  • FreeTextIndexCreated

  • FullTextCatalogName

  • IsVirtualCatalog

  • IsVirtualCatalogView

  • Locale

  • ProductId

  • ProductTableUpdated

  • ReportingLanguage

  • StartDate

  • TimeStamp

  • VariantId

  • WeightMeasure

Permissions

See Also

Reference

CatalogsDataSetSchema Class

CatalogsDataSetSchema Members

Microsoft.CommerceServer.Catalog Namespace