CatalogsDataSet
The CatalogsDataSet class contains information about the catalogs in the Catalog System. You can access the DataRowCollection by using the Catalogs property. You can access each row in the collection by using the properties of the CatalogsDataSet..::.Catalog class. This dataset contains both the built-in catalog attributes and user-defined catalog attributes in the Catalog System.
The following table contains the strongly typed properties in this dataset.
Property |
Description |
|---|---|
Gets or sets an integer value that specifies whether the virtual catalog is materialized. This property is a value of the CatalogFlags enumeration. The possible values are as follows:
This property is always 0 for base catalogs. |
|
This integer property is used internally by the Catalog System and should not be used. |
|
Gets or sets a string that contains the name of the catalog; maximum length is 85 characters. |
|
Gets or sets an integer that specifies the status of the catalog. |
|
Gets or sets a string that specifies the currency for this catalog; maximum length is 128 characters. |
|
Gets or sets a Boolean value that specifies whether this catalog is a custom catalog. |
|
Gets or sets a string that contains the default language for this catalog; maximum length is 10 characters. The default language should be set to one of the languages in the catalog. |
|
Gets or sets a string that contains the display name for the catalog; maximum length is 128 characters. This property represents the display name of the catalog in the active language. |
|
Gets or sets a DateTime value that specifies the end date for the catalog. |
|
Gets or sets a DateTime value that specifies when the free-text index was created. |
|
Gets or sets a string that contains the name of the full-text catalog. |
|
Gets or sets an integer value that specifies whether this catalog is defined as a virtual catalog or a base catalog. The possible values are as follows:
|
|
Gets or sets a Boolean value that specifies whether this catalog is part of the virtual catalog view. |
|
Gets or sets an integer that specifies the locale identifier for the catalog. |
|
Gets or sets a string that contains the product identifying property for the catalog; maximum length is 128 characters. This property is null for virtual catalogs. |
|
Gets or sets a DateTime value that specifies when the product table was last updated. |
|
Gets or sets a string that contains the reporting language for this catalog; maximum length is 10 characters. |
|
Gets or sets a DateTime value that specifies when this catalog will become valid. |
|
Gets or sets a binary value that specifies when this row was last updated. This value is for internal use only. |
|
Gets or sets a string that contains the identifier property for the variant; maximum length is 100 characters. This property will be null for virtual catalogs. |
|
Gets or sets a string that contains the weight measure for this catalog; maximum length is 128 characters. |
For each language in the Catalog System, the CatalogsDataSet class contains a column named DisplayName_<languageidentifier>. This column contains the display name of the catalog in the language identified by languageidentifier.
Constraints
The CatalogsDataSet class defines a unique constraint on the CatalogName, Currency, DefaultLanguage, DisplayName, ProductId, ReportingLanguage, VariantId, WeightMeasure, and CatalogId columns.
Using the CatalogsDataSet Class
The following example demonstrates how to access the properties of the CatalogsDataSet class.
public static void UseDataset(CatalogContext catalogContext)
{
// Iterate through the catalogs in the Catalog System to access attributes.
foreach(CatalogsDataSet.Catalog catalog in catalogContext.GetCatalogs().Catalogs)
{
string catalogName = catalog.CatalogName;
string catalogDisplayName = catalog.DisplayName;
string currency = catalog.Currency;
CatalogFlags catalogFlag = (CatalogFlags) catalog.CatalogFlags;
}
}
The CatalogsDataSetSchema Class
The CatalogsDataSetSchema class provides constants for all the built-in columns in the dataset and defines all the associated methods. The following table contains the associated methods for this class.
Method |
Description |
|---|---|
Returns true if the columnName in the dataset cannot be updated, or false if the columnName in the dataset can be updated. |
|
Returns true if the columnName is a built-in column in the dataset, or false if the columnName is a user-defined property. |