CatalogItemListCreateListControl Class

A create list control. Introduced in v2.5.

Remarks

The CatalogItemListCreateListControl is a button which the shopper can click in order to create a new Item list.

An example of the CatalogItemListCreateListControl in use is below:

Clicking the button triggers a pop-up to appear. Below is an example image of the pop-up created by the CatalogItemListControl:

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.

Create List Properties

It is possible to customize the Item List Create List Control by editing both create list properties and pop up properties. The CreateListHeadlineText property value can set the create list headline text. Likewise, the CreateListLinkText property value will be displayed as the list link text. Similarily the CreateListType property gets or sets the type of the create list.

Pop Up Properties

Just as it is possible to customize the Item List Create List Control using Create List Properties you can also edit the pop up properties. The ItemListPopUpHeaderLabelText property can be edited to set the item list pop up header label text. Similarily, the ItemListPopUpHeaderTextColor property value determines the color of the pop up header text. Lastly, the PopUpHighlightColor property value can be set to determine the color of the pop up highlight.

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.

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.

CatalogItemListCreateListControl.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogItemListCreateListControl.ascx.cs" Inherits="Dovetail.Ecommerce.Controls.CatalogItemListCreateListControl" %>
<dx:ASPxHyperLink ID="lnkCreateList" runat="server" />
<dx:ASPxPopupControl ID="popCreateList" runat="server" Modal="true" Top="75" cssClass="createList"  ShowCloseButton="true" CloseAction="CloseButton" 
    HeaderText="Create a New List" PopupHorizontalAlign="WindowCenter">
    <ContentCollection>
        <dx:PopupControlContentControl runat="server">
            <h3>Create a New list.</h3>
            <dx:ASPxTextBox ID="txtNewListName" runat="server" Width="250" Caption="Name of new list:" />
            <br />
            <dx:ASPxButton ID="btnCreateNewList" runat="server" AutoPostBack="false" Text="Create" />
        </dx:PopupControlContentControl>
    </ContentCollection>
</dx:ASPxPopupControl>
<dx:ASPxCallback ID="clbkCreateList" runat="server" OnCallback="clbkCreateList_Callback" />

Inheritance Hierarchy

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

Reference

CatalogItemListCreateListControl Members
Dovetail.Ecommerce.Controls Namespace

Version 2.5 New Features

Account and Customer Item Lists (#4817)