The CatalogItemListingByCategoryControl displays a list of Items by Category.
The CatalogItemListingByCategoryControl displays a list of Items by Category.
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.
There are a number of properties which dictate the header text of this control. These properties include the DescriptionHeaderText, NameHeaderText, PricingHeaderText, ProductLinkHeaderText, QtyinStockHeaderText, StockCodeHeaderText, and UomConversionHeaderText property which sets the description, name, pricing, product link, quantity in stock, stock code, and unit of measure conversion header text respectively.
In order to select the mode you must use the Mode property.
There are multiple properties that dictate what is displayed in this control. The following are displays that have a default value of "false" should you wish for these to be displayed you must change the value to "true".
There are multiple properties that dictate what is displayed in this control. The following are displays that have a default value of "true" should you wish for these to not be displayed you must change the value to "false".
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 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.
The table below lists and describes sub controls used by the default CatalogItemListingByCategoryControl.
Sub Control | Description |
---|---|
CatalogPricingControl | Displays the pricing for an Item. |
CatalogItemImageControl | Displays the featured image and Item detail images that have a zoom feature. |
CatalogOnHandQuantityDisplayControl | Displays messages regarding available Item quantity and lead time. |
<Control src="CatalogItemListingByCategoryControl.ascx" ShowStockCode="true" StockCodeHeaderText="Stock Code" ShowName="true" NameHeaderText="Name Header Text" ShowDescription="true" ShowUomConversion="true" ShowProductLink="true" DescriptionHeaderText="Description Header Text" ShowQtyinStock="true" QtyinStockHeaderText="Quantity In Stock Header" PricingHeaderText="Pricing Header" UomConversionHeaderText="UoM Conversion Header" ProductLinkHeaderText="Link Header" HideQuantityInput="NO_VALUE_SPECIFIED" AddtoCartText="Add to Cart" ListPriceLabel="List Price:" YourPriceLabel="Your Price:" PriceLabel="Price Label:" LimitedAvailableMessage="<nobr>[QTY] [UOM] In Stock</nobr></br>" LimitedUnavaliableMessage="<nobr>Restocking in 2 to 3 days</nobr></br>" UnlimitedAvailableMessage="<nobr>[QTY] [UOM] In Stock</nobr></br>" UnlimitedUnavailableMessage="<nobr>Ships in 2 weeks<nobr></br>" LeadTimeMessage="Leadtime: [LEADTIME]</br>" EnableOnHandQuantityDisplay="true" EnableLeadTimeMessage="true" />
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.
System.Object
System.Web.UI.Control
System.Web.UI.TemplateControl
System.Web.UI.UserControl
Dovetail.Ecommerce.ControlBases.CyberStoreBaseControl
Dovetail.Ecommerce.ControlBases.ListingControl
Dovetail.Ecommerce.Controls.CatalogItemVerticleListingControl
Dovetail.Ecommerce.Controls.CatalogItemListingByCategoryControl