Share via


GetDefinitionProperties Method (CatalogDefinitionType)

Returns a CatalogDefinitionPropertiesDataSet containing all the properties in all the definitions of the type CatalogDefinitionType.

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

Syntax

'Declaration
Public Function GetDefinitionProperties ( _
    definitionType As CatalogDefinitionType _
) As CatalogDefinitionPropertiesDataSet
'Usage
Dim instance As CatalogContext
Dim definitionType As CatalogDefinitionType
Dim returnValue As CatalogDefinitionPropertiesDataSet

returnValue = instance.GetDefinitionProperties(definitionType)
public CatalogDefinitionPropertiesDataSet GetDefinitionProperties(
    CatalogDefinitionType definitionType
)
public:
CatalogDefinitionPropertiesDataSet^ GetDefinitionProperties(
    CatalogDefinitionType definitionType
)
public function GetDefinitionProperties(
    definitionType : CatalogDefinitionType
) : CatalogDefinitionPropertiesDataSet

Parameters

Return Value

Type: Microsoft.CommerceServer.Catalog..::.CatalogDefinitionPropertiesDataSet
A CatalogDefinitionPropertiesDataSet containing the definition properties in all the definitions of the type CatalogDefinitionType.

Remarks

Retrieves a CatalogDefinitionPropertiesDataSet containing all the properties in all the definitions of the type CatalogDefinitionType.

The GetDefinitionProperties method can be used to retrieve properties of either category or product definitions.

Examples

This example shows how to retrieve all the properties in all the category definitions in the catalog system.

private void GetDefinitionProperties(CatalogContext catalogContext)
{
  CatalogDefinitionPropertiesDataSet catalogDefinitionProperties = catalogContext.GetDefinitionProperties(CatalogDefinitionType.CategoryDefinition);
  foreach(CatalogDefinitionPropertiesDataSet.CatalogDefinitionProperty catalogDefinitionProperty in catalogDefinitionProperties.CatalogDefinitionProperties)
  {
    string definitionName = catalogDefinitionProperty.DefinitionName;
    string propertyName = catalogDefinitionProperty.PropertyName;
  }
}

Permissions

See Also

Reference

CatalogContext Class

CatalogContext Members

GetDefinitionProperties Overload

Microsoft.CommerceServer.Catalog Namespace