You are here: Ektron Namespace > Server Controls API > Ektron.Cms Namespace > Ektron.Cms.Controls Namespace > Classes > ProductList Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
ProductList Class
C#
[DefaultProperty("DefaultProductListID"), ToolboxData("<{0}:ProductList runat=server></{0}:ProductList>")]
public class ProductList : ECommerceControl, ICallbackEventHandler;
Visual Basic
<DefaultProperty("DefaultProductListID"), ToolboxData("<{0}:ProductList runat=server></{0}:ProductList>")>
Public Class ProductList
Inherits ECommerceControl
Inherits ICallbackEventHandler

ProductList.cs

This is class Ektron.Cms.Controls.ProductList.

Name 
Description 
The methods of the ProductList class are listed here. 
The properties of the ProductList class are listed here. 
 
Name 
Description 
 
Fill 
Method that can be overridden and used to grab data from the back end for each server control.  
 
Wraps the resulting collection with the Ektron Toolbars, which will only display when a user is logged in.  
 
Wrap 
Method that can be overridden and used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.  
 
Name 
Description 
 
Specify an external XSLT file to render the control. By default, the control uses ProductList.xsl. This file is located in:  
 
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.  
 
Returns a List of Product Entry Data.  
 
Enter a comma separated list of IDs when the SourceType property is set to IdList, TaxonomyList or CatalogList.  
 
Image to show while Ajax is fetching data. The default is ajax-loader_circle_lg.gif.  
 
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.  
 
The number of pages to show before and after the current page. Enter zero to show all pages.  
 
Allows a developer to set the criteria for getting products from CMS400.NET.  
 
When SourceType is set to SourceObjectType.Catalog, setting Recursive to true will cause the control to include products from all child catalogs contained within the catalog specified by the supplied catalog ID.  
 
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 sort the list from 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 item.
  • Price Descending - sorts by price from highest to lowest.
  • Price Ascending - sorts by price from lowest to highest.
 
 
The ID of the catalog or taxonomy that is being used as a product list. This property is used when the SourceType property is set to Catalog or Taxonomy.  
 
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... more 
 
Specify the path to a style sheet for use with this sever control. The location can be relative or absolute. Leave blank to use the default style sheet.  
 
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 Movie are available in code behind. To retrieve the all of the 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.... more 
 
Specify the URL that contains the Product server control. This allows a site visitor to see the details of the product when the product link is clicked.  
 
When true, uses Microsoft Ajax.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!