CyberStore Documentation
CatalogItemListButtonControl Class

Dovetail.Ecommerce.Controls Namespace : CatalogItemListButtonControl Class
A catalog Item list button control. Introduced in v2.5.

The CatalogItemListButtonControl is a button which the shopper can use to add an Item to one of their personal lists.

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

General Properties

The Item_ID and the StockCode properties gets the identifier and stock code of the item. Similarily, the PopUpHighlightColor property gets the set color of the pop up highlight. This color can also be changed using the PopUpHighlightColor property.

List Properties

The AddToListIconPath  gets or sets the full pathname of the add to list icon file.

The ItemInListIconPath gets or sets the full pathname of the in list icon file.

The AddToListLabelText gets or sets the add to list label.

The AccountListsLabelText gets or sets the account lists label text.

The CustomerListsLabelText gets or sets the customer lists label text.

The ItemInListLabelText gets or sets the in list label.

The ShowItemListButton gets or sets a value indicating whether the item list button is shown.

The CustomerListsDisabledMessage gets or sets the message describing the customer lists disabled status.

The ItemListPopUpHeaderLabelText gets or sets the item list pop up header label text.

The ItemListPopUpHeaderTextColor gets or sets the color of the pop up header text.

The ItemListPopupHorizontalAlign gets or sets the item list popup horizontal align position.

The ItemListPopupVerticalAlign gets or sets the item list popup vertical align position.

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


See Also


CatalogItemListButtonControl Members
Dovetail.Ecommerce.Controls Namespace

Version 2.5 New Features

Account and Customer Item Lists (#4817)