CyberStore Documentation
ListingControl Class
Members 


Dovetail.Ecommerce.ControlBases Namespace : ListingControl Class
An Item listing control.
Remarks

The ListingControl base class provides shared fields and properties to sub controls that function to list many Items or Categories at a time based on some grouping trait such as Category, search context, Model, etc.

The following are the available sub controls which inherit the ListingControl base class:

 

Note:

While all controls sharing a base control have common properties, these are only a potential subset of available properties as each individual control contains features and functionality specific to its design.

Be sure to review each child control in the Control Library for more information.

 

 

 

Property Usage

Properties Specific to the Base ListingControl

The properties contained in the ListingControl base class are available to either include or exclude certain data from the scope of Items being listed in the control.

To expand the scope of Items to be inclusive of all Items in the current Category and all of its child hierarchy, set the IncludeItemsFromAllChildCategories property to true, or conversely to limit scope just to the current Category, set its value to false.

Scope can also be limited, or expanded, based on the type of Item in the listing. Use the IncludeModelsIncludeSKUs, and IncludeStockCodes properties to do this. Set them to true to include, and false to exclude.

The OverrideCategoryList property allows for the ListingControl to ignore the current Category in context and use a specified list of Categories as specified by a comma-separated list of Category_ID values. For example "1,5,7,124,678".

Properties Inherited from the Base CyberStoreBaseControl

Properties specific to the CyberStoreBaseControl can be listed in the following categories:

Override Properties

When the IgnoreControl property is set to true, all processing of a control is skipped, and the control's Visible property is set to false ensuring that it is not rendered in the resulting CyberStore page.

Contextual Properties

Contextual properties define specific details about the current instance of the control based on context. Context can be set by any number of factors including the log in state of the Shopper, the Site being visited, or the properties that have been established for a control.

The AttributesBag property is used internal to control processing and is the collection of attributes, or properties, and their values based on how the control is configured. The attributes in this property are set by processing the SitePages.config file as well as any specific declared property values in any registered sub controls. It allows for the passing down of all properties to a control and any registered sub controls.

The ComConfigUserData and Site_ID properties are read-only values made available to all CyberStore controls to aid in processing and establishing context about the Site and Shopper.

Inheritance Hierarchy

System.Object
   System.Web.UI.Control
      System.Web.UI.TemplateControl
         System.Web.UI.UserControl
            Dovetail.Ecommerce.ControlBases.CyberStoreBaseControl
               Dovetail.Ecommerce.ControlBases.ListingControl
                  Dovetail.Ecommerce.Controls.CatalogAvailableToPromiseReportControl
                  Dovetail.Ecommerce.Controls.CatalogCategoryDiagramListing
                  Dovetail.Ecommerce.Controls.CatalogCategoryInformation
                  Dovetail.Ecommerce.Controls.CatalogCategoryListControl
                  Dovetail.Ecommerce.Controls.CatalogCategoryQuickViewControl
                  Dovetail.Ecommerce.Controls.CatalogCategorySearchDisplayControl
                  Dovetail.Ecommerce.Controls.CatalogCategorySearchListControl
                  Dovetail.Ecommerce.Controls.CatalogDataViewControl
                  Dovetail.Ecommerce.Controls.CatalogHotbuyControl
                  Dovetail.Ecommerce.Controls.CatalogHotbuyVerticleListingControl
                  Dovetail.Ecommerce.Controls.CatalogHotSpotListingControl
                  Dovetail.Ecommerce.Controls.CatalogItem2xListingControl
                  Dovetail.Ecommerce.Controls.CatalogItemDiagramListing
                  Dovetail.Ecommerce.Controls.CatalogItemListingGroupByCategoryControl
                  Dovetail.Ecommerce.Controls.CatalogItemSKUListingControl
                  Dovetail.Ecommerce.Controls.CatalogItemTextLinkListControl
                  Dovetail.Ecommerce.Controls.CatalogItemTileListingControl
                  Dovetail.Ecommerce.Controls.CatalogItemVerticleListingControl
                  Dovetail.Ecommerce.Controls.CatalogRelatedItemsControl
                  Dovetail.Ecommerce.Controls.CatalogSearchControl
                  Dovetail.Ecommerce.Controls.CS2_CatalogHotbuyControl
                  Dovetail.Ecommerce.Controls.DataDisplayControl

See Also

Reference

ListingControl Members
Dovetail.Ecommerce.ControlBases Namespace