Product List Server Control

Authenticated

Indicates if you are logged in to the CMS Explorer
and can use it to browse to Content, Collections, etc. See Also: Using CMS Explorer to Browse Your Ektron CMS400.NET Site

CacheInterval

Sets the amount of time the server control’s data is cached. The default is 0 (zero). This is the amount of time, in seconds, a control’s data is cached. For example, if you want to cache the data for five minutes, set the CacheInterval property to 300 (three hundred). See Also: Caching with Server Controls

CustomXml

(Code Behind Only)

Provides a mechanism to inject custom XML into the generated XML before being processed by the XSLT. The injected XML is appended to the end of the XML produced by this control.

See Also: Displaying Custom XML in Ektron’s Server Controls

DisplayXslt

Specify an external XSLT file to render the control. By default, the control uses ProductList.xsl. This file is located in
<SiteRoot>\Workarea\Xslt\Commerce

Important: If you want to edit this file, it is strongly recommended that you make a copy, change its name and move it outside your site’s Workarea folder. If you make changes to this file and do not move it out of the Workarea folder, this file and the changes will be lost when you upgrade.

DoInitFill

By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, FIll is automatically called during the Page Render event.

You might do this if you need to set or change a property on the control in codebehind and have it render with your changes shown.

DynamicParameter

Sets the QueryString parameter to read a source’s ID dynamically. For example, if your QueryString parameter for a source ID is SID, enter that. See Also: SourceId.

Set to true if you want the average ratings for this product to appear within the product display, as shown below. (Notice the stars below the price of the item.)

Below the rating (shown as one through five stars) is a number indicating how many site visitors have rated the product.

Note: For more information on letting customers rate your products, see ContentReview Server Control.

Warning! This property only provides reliable data when the Business Analytics Feature is on. Enabling the Business Analytics Feature.

Hide

Used to hide the control in design time and run time.

True = Hide the control

False = Show the control

IdList

Enter a comma separated list of IDs when the SourceType property is set to IdList, TaxonomyList or CatalogList. See Also: Source Type Table

Language

Set a language for viewing a product list. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

LoadingImage

The image to display while the Product List is loading.

The default is <siteroot>\Workarea\images
\application\ajaxloader_circle_lg.gif.

OrderBy

(SortMode property must be set to None)

For further definition of the values shown here, see the entryProperty enumeration in the API documentation. Documents are located at this URL: http://ektron.com/Resources/Product-Documentation/

AverageRating

CatalogId

CollItemsDisplayOrder (only available if SourceType property = Collection)

ContentStatus

CurrencyId

EndDate

EntryType

GoLIve

Html

Id

IsArchived

IsBuyable

IsPublished

LanguageId

LastEditDate

LastEditorFirstName

LastEditorLastName

ListPrice

Media

NumberRated

ProductTypeId

SalesPrice

Sku

Status

Summary

TaxClassId

TaxItemsDisplayOrder (only available if SourceType property = Taxonomy)

Title

ViewCount

PageSize

Specify the number of items to show per page when a site visitor views the product list. If the number of items exceeds the quantity defined in this property, the list is paged and the site visitor can use the paging navigation system to move through the list.

PageSpan

The number of pages to show before and after the current page. Enter zero to show all pages.

For example, if you set this property to 2 and you are on page four of the product list, you see:

SortMode

Select the default way the product list is sorted when a site visitor first views the page. Once the page is loaded, a site visitor can change the sort via a drop down list. Choices are:

Title - sorts in alphabetical order.

SKU - sorts by the product number. This number is typically a unique number supplied by the producer of the product.

Price Descending - sorts by price from highest to lowest.

Price Ascending - sorts by price from lowest to highest.

Highest Rated - sorts by rating from highest to lowest.

Lowest Rated - sorts by rating from lowest to highest.

Most Rated - sorts by products that have most ratings from highest to lowest.

None - Use this setting to use OrderBy property.

See Also: Sorting the Product List

SourceId

The ID of the catalog, collection or taxonomy that is being used as a product list. This property is used when the SourceType property is set to Catalog, Collection or Taxonomy.

See Also: Source Type Table

SourceType

The type of source being used to create the list. Choices are:

Catalog - use the SourceId property to specify the ID of a single catalog when this source type is selected.

CatalogList - use the IdList property to specify a list of catalog IDs when this source type is selected.

Taxonomy - use the SourceId property to specify the ID of the single taxonomy when this source type is selected.

TaxonomyList - Use IdList property to specify a list of taxonomy IDs when this type is selected.

IdList - Use the IdList property to specify a list of product IDs when this source type is selected.

Collection - use the SourceId property to specify the ID of a collection when this source type is selected.

See Also: Source Type Table

Stylesheet

Specify the path to a style sheet for use with this server control. The location can be relative or absolute.

SuppressWrapperTags

Suppresses the output of the span/div tags around the control. The default is False.

True - Suppress wrap tags.

False - Allow wrap tags.

TaxonomyDepth

Enter the number of taxonomy levels to retrieve below each taxonomy/category. Only the top level is displayed in the control. The rest of the levels are available through XML in code behind. For example, if the taxonomy is DVDs > Movies > Comedies, and you set Taxonomy Depth to 2, only DVDs and Movies are available in code behind.

To retrieve all categories for a taxonomy recursively, enter -1.

A depth greater than 1 or using -1 is only useful if you create a custom output using the Taxonomy’s XML.

The default value is 1.

For a live site, Ektron strongly recommends leaving this value at 1. Increasing this value can slow down your live Web server. However, for testing on a staging server, you can increase the depth.