CatalogItemQuantityDiscountDisplay Class

A catalog Item quantity discount display control.

Remarks

The CatalogItemQuantityDiscountDisplay displays a table containing the discount breaks for an Item based off of the quantity discounts and Contract pricing. This control is not intended for use within SitePages.

An example of the CatalogItemQuantityDiscountDiplay 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.

Properties Specific to the CatalogItemQuantityDiscountDisplay Control

The control creates a table consisting of First, Middle, and Last rows. To format these rows according to type, use the corresponding property within the control: FirstRangeFormat, MiddleRangeFormat, and LastRangeFormat. Use [START] and [END] to add range values to the display (e.g., "[START] to [END]"). Note that "[END]" is not available in LastRangeFormat.

Display of the last Item in the range is optional. Use "DisplayLastRange=false" to hide the last range.

Properties Inherited from the Base ItemControl

The properties contained in the ItemControl base class allow for options regarding the type of Item that is in context for the control.

The properties IgnoreWhenModel, IgnoreWhenSKU, and IgnoreWhenStockCode properties can be used to case the ItemControl to not process nor render when the appropriate Item type is valid for the Item.

Properties Inherited from the Base CyberStoreBaseControl

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

Override Properties
Contextual Properties

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 ComConfig, UserData 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.

Example

See an example of how to configure this control in SitePages.config.

<Control src="CatalogItemQuantityDiscountDisplay.ascx"
       FirstRangeFormat="[START] to [END]"
       MiddleRangeFormat="[START] to [END]"
       LastRangeFormat="More than [START]"  
       DisplayLastRange="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.

CatalogItemQuantityDiscountDisplay.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogItemQuantityDiscountDisplay.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItemQuantityDiscountDisplay" %>
<asp:Repeater ID="QtyDiscountRptr" runat="server">
    <HeaderTemplate>
        <table class="CatalogItemQuantityDiscountTable">
            <tr class="CatalogItemQuantityDiscountHeaderRow">
                <td>
                    <b>Qty</b>
                </td>
                <td>
                    <b>Price</b>
                </td>
            </tr>
    </HeaderTemplate>
    <ItemTemplate>
        <tr class="CatalogItemQuantityDiscountRow">
            <td class="CatalogItemQuantityDiscountQtyCell">
                <%#DataBinder.Eval(Container, "DataItem.FormattedDisplay")%>
            </td>
            <td class="CatalogItemQuantityDiscountPriceCell">
                <%#DataBinder.Eval(Container, "DataItem.FormattedValue")%>
            </td>
        </tr>
    </ItemTemplate>
    <FooterTemplate>
        </table>
    </FooterTemplate>
</asp:Repeater>

Inheritance Hierarchy

System.Object
   System.Web.UI.Control
      System.Web.UI.TemplateControl
         System.Web.UI.UserControl
            Dovetail.Ecommerce.ControlBases.CyberStoreBaseControl
                  Dovetail.Ecommerce.Controls.CatalogItemQuantityDiscountDisplay

Reference

CatalogItemQuantityDiscountDisplay Members
Dovetail.Ecommerce.Controls Namespace