CyberStore Documentation
CatalogItem2xListingControl Class
Members  Example 


Dovetail.Ecommerce.Controls Namespace : CatalogItem2xListingControl Class

A catalog Item 2x listing control.

Remarks

The CatalogItem2xListingControl displays a listing of Items in a two-column format based on search criteria and/or Category filtering.

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

The CurrentPage gets the current page. Meanwhile, the PageSize sets the current page size (the number of records per page).

Sort Order Properties

The CurrentSortOrder sets the current sort order. Likewise, the RepeatDirection property sets the direction to display sorted items by within the grid.

Photo Properties

The photoLocation gets or sets the photo location. The UsePhoto  gets or sets which photo to display. The PhotoWidth gets or sets 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 CatalogItem2xListingControl.

Sub Control Description
CatalogItemImageControl Displays the featured image and Item detail images that have a zoom feature.
CatalogPricingControl Displays the pricing for an Item.
CatalogOnHandQuantityDisplayControl Displays messages regarding available Item quantity and lead time.
Example
See an example of how to configure this control in SitePages.config.
<Control src="CatalogItem2xListingControl.ascx"
       PhotoWidth="55"
       UsePhoto="Photo1"
       HideQuantityInput="NO_VALUE_SPECIFIED"
       AddtoCartText="Add to Cart"
       ListPriceLabel="List Price:"
       YourPriceLabel="Your Price:"
       PriceLabel="Price Label:"
       LimitedAvailableMessage="&lt;nobr&gt;[QTY] [UOM] In Stock&lt;/nobr&gt;&lt;/br&gt;"
       LimitedUnavaliableMessage="&lt;nobr&gt;Restocking in 2 to 3 days&lt;/nobr&gt;&lt;/br&gt;"
       UnlimitedAvailableMessage="&lt;nobr&gt;[QTY] [UOM] In Stock&lt;/nobr&gt;&lt;/br&gt;"
       UnlimitedUnavailableMessage="&lt;nobr&gt;Ships in 2 weeks&lt;nobr&gt;&lt;/br&gt;"
       LeadTimeMessage="Leadtime: [LEADTIME]&lt;/br&gt;"
       EnableOnHandQuantityDisplay="true"
       EnableLeadTimeMessage="true" />
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="CatalogItem2xListingControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItem2xListingControl" %>
<@ Register TagPrefix="uc1" TagName="CatalogItemImageControl" Src="~/Control/CatalogItemImageControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogSimplePricingControl" Src="~/Control/CatalogSimplePricingControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogOnHandQuantityDisplayControl" Src="~/Control/CatalogOnHandQuantityDisplayControl.ascx" >
<asp:Panel runat="server" ID="Results" Visible="true">
    <span class="CatalogListSortLabel">Sort By:
        <asp:DropDownList ID="Sort" CssClass="CatalogListSortSelect" AutoPostBack="true"
            runat="server" OnSelectedIndexChanged="Sort_SelectedIndexChanged">
            <asp:ListItem Value="SortOrder">Select One</asp:ListItem>
            <asp:ListItem Value="ItemName">Name</asp:ListItem>
            <asp:ListItem Value="StockCode">Stock Code</asp:ListItem>
            <asp:ListItem Value="UnitPrice">Price</asp:ListItem>
        </asp:DropDownList>
    </span>
    <asp:DataList ID="ListingGrid" CssClass="DefaultTable" runat="server" BorderWidth="0px"
        HeaderStyle-CssClass="HighlightTableRow" RepeatColumns="2" OnItemDataBound="ListingGrid_OnItemCreated">
        <AlternatingItemStyle CssClass="CatalogHighlightTableRow"></AlternatingItemStyle>
        <ItemTemplate>
            <span class="CatalogFeaturedItemHeadline">
                <%# DataBinder.Eval(Container.DataItem, "HeadLine") %>
            </span>
            <br />
            <span class="CatalogProduct2DListStockCodeLabel">Stock Code:</span><br />
            <span class="CatalogProduct2DListStockCode">
                <%# DataBinder.Eval(Container.DataItem, "StockCode") %>
            </span>
            <br />
            <uc1:CatalogSimplePricingControl ID="Catalogaddtocartbutton2" runat="server" Item_ID='<%# Convert.ToInt32(DataBinder.Eval(Container.DataItem, "Item_ID"))%>' />
            <uc1:CatalogOnHandQuantityDisplayControl Item_ID='<%# DataBinder.Eval(Container.DataItem, "Item_ID")%>'
                ID="OnHandQuantityDisplay" OnHandDisplayCssClass="OnHandQuantityItemVerticleListing"
                runat="server" />
            <uc1:CatalogItemImageControl ID="ItemImage" runat="server" PhotoWidth='<#PhotoWidth>'
                PhotoLocation="<%# UsePhoto %>" StockCode='<%# DataBinder.Eval(Container.DataItem, "Stockcode")%>'
                PhotoAltText='<%# DataBinder.Eval(Container.DataItem, "Stockcode")%>' PhotoCssClass="CatalogProductVerticalListPicture"
                PictureNotFoundCssClass="CatalogProductVerticalListPictureNotFound" Item_ID='<#Convert.ToInt32(Eval("Item_ID"))>'/>
        </ItemTemplate>
        <HeaderStyle CssClass="HighlightTableRow"></HeaderStyle>
    </asp:DataList>
    <br>
    <asp:LinkButton ID="Previous" runat="server" EnableViewState="false" OnClick="Previous_Click">Previous</asp:LinkButton>
    <asp:LinkButton ID="Next" runat="server" EnableViewState="false" OnClick="Next_Click">Next</asp:LinkButton>
    <br>
    <asp:Label ID="PageNumberDisplay" runat="server">Page <%#CurrentPage.ToString().ToString()  %> of <%#PageCount.ToString()  %></asp:Label>
</asp:Panel>
<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.</div>
</asp:Panel>
<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.
    </div>
</asp:Panel>
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.CatalogItem2xListingControl

See Also

Reference

CatalogItem2xListingControl Members
Dovetail.Ecommerce.Controls Namespace