CyberStore Ecommerce 2023 Documentation
CatalogAddtoCartButton Class
Members  Example 


Dovetail.Ecommerce.Controls Namespace : CatalogAddtoCartButton Class
Obsolete. Implements the CatalogPricingControl.
Remarks

The CatalogAddtoCartButton control was formerly used to implement the Add to Cart button. It has been deprecated and its functionality is now included in the CatalogPricingControl.

Adding this control implements the CatalogPricingControl.

About Obsolescence

When a feature, control, widget, or any item in the CyberStore application framework is made Obsolete, it is replaced with some newer functionality. Existing functionality either continues to be available (but future development of the feature ceases) or is altered to deliver the newer functionality automatically. At some future date, an obsolete item will be completely deprecated meaning that it will no longer exist or be available.

It is strongly suggested that any customization that uses an obsolete functionality be updated to utilize the newer counterpart.

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.

 Using the Item_ID property you can gets or set an item_ ID.  

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 CatalogAddtoCartButton control.

Sub Control Description
CatalogPricingControl Displays the pricing for an Item.
Example
See an example of how to configure this control in SitePages.config.
<Control src="CatalogPricingControl.ascx"
   AddtoCartText="Add to Cart"
   AddtoCartStandardText="Add Standard"
   AccessorizeText = "Add with Options"
   ListPriceLabel="List Price:"
   YourPriceLabel="Your Price:"
   PriceLabel="Price Label:"
/>
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="CatalogAddtoCartButton.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogAddtoCartButton" %>
<@ Register TagPrefix="uc1" TagName="CatalogSimplePricingControl" Src="~/Control/CatalogSimplePricingControl.ascx" >

<uc1:CatalogSimplePricingControl ID="PricingControl1" runat="server" Item_ID="<#Item_ID>" />
Inheritance Hierarchy

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

See Also

Reference

CatalogAddtoCartButton Members
Dovetail.Ecommerce.Controls Namespace