CyberStore Documentation
CatalogItemCharacteristicTabsDisplayControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : CatalogItemCharacteristicTabsDisplayControl Class
A catalog Item Characteristic tabs display control.
The CatalogItemCharacteristicTabsDisplayControl creates a tabbed interface that lists the Characteristic Values for each Item. Each tabbed block represents a Characteristic Family.

During implementation, you can specify which Characteristic Families you want to use in the FamilyNames property. With the TabsLocation property, you can set the location of the rendered tabs: Top (default), Bottom, Left, or Right of the control. The control utilizes the default CatalogItemCharacteristicDisplayControl when rendering the output. To utilize a custom version of that control, specify the full control path using the CharacteristicDisplayControlPath property.

When there are no Characteristics for an Item in a specific Family, the visibility of that Family's tab depends on the value of the HideOnEmpty property.

When configuring the CatalogItemCharacteristicTabsDisplayControl within your SitePages.config file for a page, include within its definition any desired properties you want to appear in the CatalogItemCharacteristicDisplayControl. These are inherited when the tables are rendered.

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.

The CharacteristicDisplayControlPath gets or sets the full pathname of the CatalogItemCharaceristicDisplayControl. Similarily, the FamilyNames property gets or sets the names of the families to use. Likewise, the TabsLocation property gets or sets the location of the tabs. 

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 IgnoreWhenModelIgnoreWhenSKU, 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

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.

See an example of how to configure this control in SitePages.config.
<Control src="CatalogItemCharacteristicTabsDisplayControl.ascx" ID ="ChracteristicTabsDisplay" Name="Characteristic Tabs"
FamilyNames="Specifications, Links"
CSS Classes
CSS Class Description
CharacteristicDisplayTabContent The style for the tab content block.
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="CatalogItemCharacteristicTabsDisplayControl.ascx.cs" Inherits="Dovetail.Ecommerce.Controls.CatalogItemCharacteristicTabsDisplayControl" %>
<dx:ASPxPageControl ID="CharacteristicFamilyTabs" Theme="Default" runat="server" ClientIDMode="AutoID" ContentStyle-CssClass="CharacteristicDisplayTabContent" />
Inheritance Hierarchy


See Also


CatalogItemCharacteristicTabsDisplayControl Members
Dovetail.Ecommerce.Controls Namespace