CyberStore Documentation
CatalogItemSKUListingControl Class

Dovetail.Ecommerce.Controls Namespace : CatalogItemSKUListingControl Class
A catalog Item SKU listing control. Introduced in v2.7.

The CatalogItemSKUListingControl displays a list of SKUs which can be selected by the current shopper. This list of SKUs is not auto-generated.

An example of the CatalogItemSKUListingControl in use is below:


Property Usage

By changing the values of the control's properties in the SitePages.config file for your Site, you can enable or disable certain behaviors, set certain defaults, alter aspects of the display or otherwise cusomtize your site's implementaion of the control.

The following describes properties pertaining to key functional areas of the control that can be configured to suit your needs.

Page Properties

It is possible to change the current page, the page size, and the SKU sort order for this control using the CurrentPagePageSize, and SKUSortOrder properties respectively.

Link Properties

There are two options for customization in regard to how links are displayed in this control. The first property which can be edited is the LearnMoreLinkCSSClass property which sets the "Learn More" link CSS class. The other property which can be edited is the LearnMoreLinkText property which sets the "Learn More" link text.

Tile Properties

There are a few properties which can be edited to change the tile display for this control. These controls include the ShowTileBorder which sets a value indicating whether the tile border is shown. The default value for this property is "true". You can also customize the tile height and tile width with the TileHeight and the TileWidth property. 

Photo Properties

To choose a photo to use input a corresponding value in the UsePhoto property. Input a value to designate as the photo location by using the photoLocation property. Change the PhotoWidth property to customize the width of the photo.

Properties Inherited from 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.

Sub Controls

The table below lists and describes sub controls used by the default CatalogItemSKUListingControl.

Sub Control Description
CatalogItemImageControl Displays the featured image and Item detail images that have a zoom feature.
Control Markup

The following is the markup for this control.

Developer's Note:

To create a custom version of the control, copy all of the code below into a file of the same name and place it into your Site's control folder (e.g., ../YourSiteFolder/Control). The CyberStore page engine will then override the default markup with your customized version.


<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogItemSKUListingControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItemSKUListingControl" %>
<@ Register TagPrefix="uc1" TagName="CatalogItemImageControl" Src="~/Control/CatalogItemImageControl.ascx" >

<asp:Panel runat="server" ID="Results" Visible="true">

<dx:ASPxDataView ID="ListingView" runat="server" ItemStyle-HorizontalAlign="Center" Layout="Flow" ItemStyle-BackColor="White" PagerSettings-EnableAdaptivity="true"  >
            <div class="Catalog2xListItemHeadline">
                <%# DataBinder.Eval(Container.DataItem, "HeadLine") %>
            <div class="CatalogProduct2DListStockCode">
                <%# DataBinder.Eval(Container.DataItem, "StockCode") %>
            <div class="List2xImage">
                <div class="List2xImageWrap">
                    <uc1:CatalogItemImageControl ID="ItemImage" runat="server" PhotoWidth='<#PhotoWidth>' 
                        PhotoLocation="<%# UsePhoto %>" StockCode='<%# DataBinder.Eval(Container.DataItem, "Stockcode")%>'
                        PhotoAltText='<%# DataBinder.Eval(Container.DataItem, "Stockcode")%>' PhotoCssClass="CatalogProduct2xListPicture"
                        PictureNotFoundCssClass="CatalogProductVerticalListPictureNotFound" Item_ID='<#Convert.ToInt32(Eval("Item_ID"))>' />
                <a class="<%= LearnMoreLinkCSSClass %>" href="<%# Dovetail.Ecommerce.BusinessLogic.Catalog.FriendlyUrl.ItemDetailPage(DataBinder.Eval(Container.DataItem, "StockCode").ToString(), DataBinder.Eval(Container.DataItem, "Name") != null ? DataBinder.Eval(Container.DataItem, "Name").ToString() : DataBinder.Eval(Container.DataItem, "StockCode").ToString()) %>"><%= LearnMoreLinkText %></a>
            <div class="List2xContent">
                <%# DataBinder.Eval(Container.DataItem, "ShortDescription")%>
<asp:Panel runat="server" ID="NoSearchResults" Visible="false">
    <div class="ValidationMessage">
        Sorry, no items were found that matched the criteria you specified in your search.
        For more comprehensive results, please browse our catalog below or try again using
        different keywords in the search panel to the left.
<asp:Panel runat="server" ID="NoItemsInCategory" Visible="false">
    <div class="ValidationMessage">
        Sorry, no items were found in this category. You can search our items by keyword
        using the Product Search in the search panel to the left.
Inheritance Hierarchy


See Also


CatalogItemSKUListingControl Members
Dovetail.Ecommerce.Controls Namespace