In this Topic Show

 

ConLib Reference Library

The ConLib Reference library is automatically updated when new controls or new control properties are added.  The control files are physically located in the \ConLib\ folder of the AbleCommerce program.  As development of AbleCommerce software is always progressing.  You should view the Help > ConLib Reference page from within the software to find the latest updates available.

Most of the controls listed below are being used by the scriptlet files.  Many of the controls have additional properties which can be implemented or modified without having to modify the control directly.  For example, the "OnePageCheckout" control has many options that you can change by simply modifying the scriptlet.  This can all be done within the AbleCommerce interface.

However, if you need to customize a control file, make sure to follow the procedure below so that any upgrades you apply will not overwrite your changes.

To Customize a Control File

You will need to access the control files directly from the server or through an FTP program.    

  1. Find the \ConLib\ folder and open it to view all the controls.  

    conlib_folders.gif

  2. Make a copy of the control files you wish to change and place them in the \ConLib\Custom\ folder.

    • A control file is actually a pair of files.  Both have the same name but different file extensions (.ascs and .ascx.cs).  Make sure to copy them both for this step.

  3. Edit the copied version of the control object and save.

  4. Login to the Merchant Administration.

  5. Go to the Website > Content and Layout page.

  6. Find the scriptlet that is, or will be, using the custom control and edit it using AbleCommerce, so a copy will automatically be placed in the \App_Data\Scriptlets\Custom\... sub-folder.

  7. Modify the reference to the control object so that it points to the custom folder.

    e.g. [[ConLib:Custom/PopularProductsDialog]]

  8. Save the scriptlet and test your changes!  

 

AddressBook

Summary:  Displays a registered user's stored addresses.

Usage: [[ConLib:AddressBook]]

AddToCartLink

Summary:  Displays a link to add an item to the cart.

Usage: [[ConLib:AddToCartLink ProductId="" ShowImage="true" LinkText=""]]

Properties:

ProductId

The ID of the product to add to the cart when the link is clicked.

ShowImage

Indicates whether an image should be displayed with the link. The image is determined by your theme.

LinkText

Text to use for the link. You can use the string {0} as a place holder for the product name.

AdvancedSearchPage

Summary:  Displays an advanced search page, to search products in the catalog.

Usage: [[ConLib:AdvancedSearchPage]]

AffiliateRegForm

Summary:  Dsiplays a form to register affiliates and edit registration information.

Usage: [[ConLib:AffiliateRegForm]]

AgreementContent

Summary:  Display page to show license agreement.

Usage: [[ConLib:AgreementContent]]

Basket

Summary:  Shows detail of items in shopping cart. And provide features like edit/remove items, different checkout options etc.

Usage: [[ConLib:Basket]]

BasketShippingEstimate

Summary:  A side bar control to estimate shipping charges for this order.

Usage: [[ConLib:BasketShippingEstimate Caption="Shipping Estimate" InstructionText="To estimate shipping charges for this order, enter your AIP or postal code below."]]

Properties:

Caption

Possible value can be any string. Title of the control.

InstructionText

Possible value cab be any suitable text.

BasketTotalSummary

Summary:  Display totals and summary of contents of basket.

Usage: [[ConLib:BasketTotalSummary]]

BreadCrumbs

Summary:  Displays dynamic bread crumb links for the current page.

Usage: [[ConLib:BreadCrumbs]]

BuyProductDialog

Summary:  Displays product details and buy now button to add it to cart.

Usage: [[ConLib:BuyProductDialog ShowSku="true" ShowPrice="true" ShowSubscription="true" ShowMSRP="true" ShowPartNumber="false"]]

Properties:

ShowSku

Possible values are true or false. Indicates whether the SKU will be shown or not.

ShowPrice

Possible values are true or false. Indicates whether the price details will be shown or not.

ShowSubscription

Possible values are true or false. Indicates whether the subscription details will be shown or not.

ShowMSRP

Possible values are true or false. Indicates whether the MSPR will be shown or not.

ShowPartNumber

Possible values are true or false. Indicates whether the Part/Model Number will be shown or not.

BuyProductDialogOptionsList

Summary:  Displays product details and buy now button to add it to cart. This control should not be used with products having more than 8 options.

Usage: [[ConLib:BuyProductDialogOptionsList ShowSku="true" ShowPrice="true" ShowSubscription="true" ShowMSRP="true" ShowPartNumber="false"]]

Properties:

ShowSku

Possible values are true or false. Indicates whether the SKU will be shown or not.

ShowPrice

Possible values are true or false. Indicates whether the price details will be shown or not.

ShowSubscription

Possible values are true or false. Indicates whether the subscription details will be shown or not.

ShowMSRP

Possible values are true or false. Indicates whether the MSPR will be shown or not.

ShowPartNumber

Possible values are true or false. Indicates whether the Part/Model Number will be shown or not.

BuyWithAgreementPage

Summary:  Page displays the license agreement details.

Usage: [[ConLib:BuyWithAgreementPage]]

CatalogTree

Summary:  Displays the catalog of your store in a treeview.

Usage: [[ConLib:CatalogTree ShowStoreNode="true" RootNodeText="Store Name" ShowAllNodes="false" PreExpandLevel="0"]]

Properties:

ShowStoreNode

If 'true' then will show the name of the store as root node.

RootNodeText

Text shown for root node, usualy the name of the store.

ShowAllNodes

If true will also display products, webpages and links.

PreExpandLevel

Represents up to which level the tree will be pre-expanded on first load.

CategoryBreadCrumbs

Summary:  Displays bread crumbs for the current category.

Usage: [[ConLib:CategoryBreadCrumbs HideLastNode="false"]]

Properties:

HideLastNode

Possible values are true or false. Indicates whether the last node i.e. the name of current category will be shown or not.

CategoryDetailsPage

Summary:  A category page that displays all contents of a category with summary description in a row format. This page displays products, webpages, and links.

Usage: [[ConLib:CategoryDetailsPage DefaultCaption="Catalog" DefaultCategorySummary="Welcome to our store."]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DefaultCategorySummary

Summary that will be shown when root category will be browsed.

CategoryDropDownList

Summary:  Displays a drop down list of categories in your store.

Usage: [[ConLib:CategoryDropDownList HomeText="Home" Prefix=" . . " Levels="0" GoButtonText="" AutoPostBack="true" CacheDuration="1440"]]

Properties:

HomeText

The string to use for the top level item that directs to your home page.

Prefix

The string to place before a subdirectory, repeated for each category level.

Levels

The maximum number of category levels to include in the list. Set to 0 for all levels.

GoButtonText

The text for the button that when clicked, will display the selected category. If you set this to an empty string, the button will be hidden.

AutoPostBack

If true, the page will automatically redirect to the category when selected. If false, the button must be clicked to navigate to the selected category.

CacheDuration

Number of minutes the category list will remain cached in memory. Set to 0 to disable caching.

CategoryGridPage

Summary:  The defualt category page that displays products in a grid format. Allows customers to browse your catalog.

Usage: [[ConLib:CategoryGridPage DefaultCaption="Catalog" DisplayBreadCrumbs="true" PagingLinksLocation="BOTTOM"]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DisplayBreadCrumbs

Indicates wheather the breadcrumbs should be displayed or not, default value is true.

PagingLinksLocation

Indicates where the paging links will be displayd, possible values are "TOP", "BOTTOM" and "TOPANDBOTTOM".

CategoryGridPage2

Summary:  A category page that displays all contents in a grid format. This page displays products, webpages, and links.

Usage: [[ConLib:CategoryGridPage2 DefaultCaption="Catalog" DisplayBreadCrumbs="true" PagingLinksLocation="BOTTOM"]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DisplayBreadCrumbs

Indicates wheather the breadcrumbs should be displayed or not, default value is true.

PagingLinksLocation

Indicates where the paging links will be displayd, possible values are "TOP", "BOTTOM" and "TOPANDBOTTOM".

CategoryGridPage3

Summary:  Category Grid with Add To Cart Option. The category page that displays products in a grid format. Allows customers to browse your catalog, with options to directly add your products to cart and specify the quantity.

Usage: [[ConLib:CategoryGridPage3 DefaultCaption="Catalog" DisplayBreadCrumbs="true" PagingLinksLocation="BOTTOM"]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DisplayBreadCrumbs

Indicates wheather the breadcrumbs should be displayed or not, default value is true.

PagingLinksLocation

Indicates where the paging links will be displayd, possible values are "TOP", "BOTTOM" and "TOPANDBOTTOM".

CategoryGridPage4

Summary:  A category page that displays all contents in a grid format. This page displays products, webpages, and links.

Usage: [[ConLib:CategoryGridPage4 DefaultCaption="Catalog" DisplayBreadCrumbs="true" PagingLinksLocation="BOTTOM" MaximumSummaryLength="250"]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DisplayBreadCrumbs

Indicates wheather the breadcrumbs should be displayed or not, default value is true.

PagingLinksLocation

Indicates where the paging links will be displayd, possible values are "TOP", "BOTTOM" and "TOPANDBOTTOM".

MaximumSummaryLength

Maximum characters to display for summary.

CategoryListPage

Summary:  A category page that displays all contents in a grid format. This page displays products, webpages, and links.

Usage: [[ConLib:CategoryGridPage4 DefaultCaption="Catalog" DisplayBreadCrumbs="true" PagingLinksLocation="BOTTOM" MaximumSummaryLength="250"]]

Properties:

DefaultCaption

Caption text that will be shown as caption when root category will be browsed.

DisplayBreadCrumbs

Indicates wheather the breadcrumbs should be displayed or not, default value is true.

PagingLinksLocation

Indicates where the paging links will be displayd, possible values are "TOP", "BOTTOM" and "TOPANDBOTTOM".

MaximumSummaryLength

Maximum characters to display for summary.

CategorySearchSidebar

Summary:  An ajax enabled search bar that displays products in a grid format. Allows customers to narrow and expand by category, manufacturer, and keyword in a search style interface. This search bar must be used in conjunction with the Category Grid content scriptlet.

Usage: [[ConLib:CategorySearchSidebar]]

CheckoutLoginDialog

Summary:  A login page which is used while an anonymous user is checking out.

Usage: [[ConLib:CheckoutLoginDialog]]

CheckoutProgress

Summary:  Displays the 4 checkout progress steps dynamically.

Usage: [[ConLib:CheckoutProgress]]

CheckoutRegisterButtonDialog

Summary:  Displays a register button for anonymous users while checkout process.

Usage: [[ConLib:CheckoutRegisterButtonDialog]]

CommunicationPreferencesSection

Summary:  A control to display communication preferences, i.e. subscription options to email lists etc.

Usage: [[ConLib:CommunicationPreferencesSection]]

CouponDialog

Summary:  Displays a form where a customer can enter coupon or promotional codes.

Usage: [[ConLib:CouponDialog]]

CreateProfilePage

Summary:  Displays a form where customer can enter personal and billing details and can create an account.

Usage: [[ConLib:CreateProfilePage]]

CustomerOrderHistoryDialog

Summary:  Displays customer recent orders list.

Usage: [[ConLib:CustomerOrderHistoryDialog Caption="My Recent Orders"]]

Properties:

Caption

Possible value can be any string. Title of the control.

Disclaimer

Summary:  Content page to show disclaimer message.

Usage: [[ConLib:Disclaimer NoCookiesMessage="Your browser does not support cookies or cookies are disabled. This site uses cookies to store information, please enable cookies otherwise you will not be able to use our site."]]

Properties:

NoCookiesMessage

Possible value can be any string. A message which will be displayed when cookies are disabled or the customer browser does not support cookies.

EditBillAddressPage

Summary:  Displays a form to edit billing address of the customer.

Usage: [[ConLib:EditBillAddressPage]]

EditMyAddressPage

Summary:  Displays a form to add/edit customer address.

Usage: [[ConLib:EditMyAddressPage]]

EditMyReviewPage

Summary:  Displays a form to edit a customer review for any product.

Usage: [[ConLib:EditMyReviewPage]]

EditShipAddressPage

Summary:  Displays a form to add/edit customer shipping address.

Usage: [[ConLib:EditShipAddressPage]]

FeaturedCategoryItems

Summary:  Displays featured items in a category.

Usage: [[ConLib:FeaturedCategoryItems Caption="Featured Items" MaxItems="3" Orientation="VERTICAL" IncludeOutOfStockItems="false"]]

Properties:

Caption

Possible value can be any string. Title of the control.

MaxItems

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

IncludeOutOfStockItems

Possible values be true of false. Indicates that the grid will display out of sctock items or not.

FeaturedProductsGrid

Summary:  Displays featured items in a category.

Usage: [[ConLib:FeaturedProductsGrid Caption="Featured Items" Size="3" Columns="2" IncludeOutOfStockItems="false" ThumbnailPosition="LEFT" Orientation="HORIZONTAL"]]

Properties:

Caption

Possible value can be any string. Title of the control.

Size

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Columns

Possible value cab be any integer greater then zero. Indicates that the grid will contain how much columns.

IncludeOutOfStockItems

Possible values be true of false. Indicates that the grid will display out of sctock items or not.

ThumbnailPosition

Possible values are 'TOP' or 'LEFT'. Indicates whether the product image will be displayed on top of product details or on the left.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

FindWishlistPage

Summary:  Displays a search form to find wishlists. Also displays the search results.

Usage: [[ConLib:FindWishlistPage]]

GiftWrapPage

Summary:  Displays giftwrap options and details when checking out.

Usage: [[ConLib:GiftWrapPage]]

GoogleAnalyticsWidget

Summary:  Widget for Google Analytics Tracking.

Usage: [[ConLib:GoogleAnalyticsWidget]]

LoginDialog

Summary:  Displays a standard login dialog that includes support for recovering forgotten passwords.

Usage: [[ConLib:LoginDialog EnableAdminRememberMe="true"]]

Properties:

EnableAdminRememberMe

Set to true or false. Indicates whether the remember me option is available to admin users.

LogoutWidget

Summary:  Handles customer logout. This is not a display control. But when a customer logout link is clicked, it is redirected to this page.

Usage: [[ConLib:LogoutWidget]]

MiniBasket

Summary:  Display the contents of items in cart. Can be used in side bars.

Usage: [[ConLib:MiniBasket AlternateControl="PopularProductsDialog.ascx"]]

Properties:

AlternateControl

A control that will be displayed when cart is empty.

MoreCategoryItems

Summary:  Displays other products in the same category.

Usage: [[ConLib:MoreCategoryItems Caption="Other Items In This Category" MaxItems="4" Orientation="HORIZONTAL" DisplayMode="SEQUENTIAL"]]

Properties:

Caption

Possible value can be any string. Title of the control.

MaxItems

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

DisplayMode

Possible values are 'SEQUENTIAL' or 'RANDOM'. Indicates whether the contents will be selected randomly or in sequence.

MyAccountPage

Summary:  Displays the content of customer account page, like recent orders and profile information.

Usage: [[ConLib:MyAccountPage]]

MyAddressBookPage

Summary:  Displays the cutomer address book with all the shipping and billing addresses.

Usage: [[ConLib:MyAddressBookPage]]

MyAffiliateAccountPage

Summary:  Content page to show options for affiliate registration and reports.

Usage: [[ConLib:MyAffiliateAccountPage]]

MyCredentialsPage

Summary:  Displays a form where customer can update email address or password.

Usage: [[ConLib:MyCredentialsPage]]

MyDigitalGoodsPage

Summary:  Display details of digital goods attached to an order and options to download them.

Usage: [[ConLib:MyDigitalGoodsPage]]

MyGiftCertificatePage

Summary:  Display gift certificate details against an order.

Usage: [[ConLib:MyGiftCertificatePage]]

MyOrderHistoryPage

Summary:  Displays order history of a customer.

Usage: [[ConLib:MyOrderHistoryPage]]

MyOrderPage

Summary:  Display page to show details of an order like order items, shipping address, billing address etc.

Usage: [[ConLib:MyOrderPage AllowAddNote="true" HandleFailedPayments="false"]]

Properties:

AllowAddNote

If true, the customer can add notes to the order. If false, the customer can only see notes added by the merchant.

HandleFailedPayments

If true, the customer is redirected to an order payment page if the payment fails at checkout.

MyProductReviewsPage

Summary:  Display page to show reviewer profile and all the reviews. Customer and edit/remove reviews here.

Usage: [[ConLib:MyProductReviewsPage]]

MySerialKeyPage

Summary:  Displays serial key for a digital good.

Usage: [[ConLib:MySerialKeyPage]]

MySubscriptionsPage

Summary:  Customer account page to display all his subscriptions and related details.

Usage: [[ConLib:MySubscriptionsPage]]

MyTrackingInfoPage

Summary:  Customer account page to show tracking details of an order shipment.

Usage: [[ConLib:MyTrackingInfoPage]]

MyWishlistPage

Summary:  Customer account page to display wishlist items of that customer with options like edit/remove and add to cart.

Usage: [[ConLib:MyWishlistPage]]

OnePageCheckout

Summary:  Displays a one page checkout form.

Usage: [[ConLib:OnePageCheckout EnableGiftWrap="true" EnableMultiShipTo="true" EnableShipMessage="false" AllowAnonymousCheckout="false" DisableBots="true" MaxCheckoutAttemptsPerMinute="10"]]

Properties:

EnableGiftWrap

Possible values are true or false. Indicates whether gift wrap options should be shown to the customer.

EnableMultiShipTo

Possible values are true or false. Indicates whether multiple shipping destinations are allowed and should be made available to the customer.

EnableShipMessage

Possible values are true or false. When true, a field is displayed for the customer to enter delivery instructions for the shipment.

AllowAnonymousCheckout

Possible values are true or false. When true, customers are allowed to check out without creating a user account.

DisableBots

Indicates whether to attempt to prevent bots and spiders from accessing the checkout page. This can be disabled if it causes undesired behavior.

MaxCheckoutAttemptsPerMinute

Number of checkout attempts a user can make within one minute. A user exceeding this limit will be considered a bot. The default value of 10 is pretty lenient.

OrderBalanceDialog

Summary:  Displays a link to make a payment when a balance is due for an order.

Usage: [[ConLib:OrderBalanceDialog Caption="Balance Due"]]

Properties:

Caption

Possible value can be any string. Title of the control.

OrderTotalSummary

Summary:  Display summary of order totals.

Usage: [[ConLib:OrderTotalSummary]]

PasswordHelpPage

Summary:  Displays a form where a customer can reset his lost password. This is part of customer password recovery feature.

Usage: [[ConLib:PasswordHelpPage]]

PaymentPage

Summary:  Standard payment page, displays all of available billing options.

Usage: [[ConLib:PaymentPage]]

PayMyOrderPage

Summary:  Customer account page that displays a form where customer can pay his due balance for an order.

Usage: [[ConLib:PayMyOrderPage]]

PayPalExpressCheckoutButton

Summary:  Displays featured items in a category.

Usage: [[ConLib:PayPalExpressCheckoutButton ShowHeader="true" ShowDescription="true" PanelCSSClass="section"]]

Properties:

ShowHeader

Possible values are true or false. Indicates whether the header will be shown or not.

ShowDescription

Possible values are true or false. Indicates whether the description will be shown or not.

PanelCSSClass

Possible value cab be any suitable text.

PopularProductsDialog

Summary:  Display top seller products.

Usage: [[ConLib:PopularProductsDialog Caption="Top Sellers" MaxItems="3" Orientation="HORIZONTAL" Columns="3" ThumbnailPosition="TOP"]]

Properties:

Caption

Possible value can be any string. Title of the control.

MaxItems

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

Columns

Possible value cab be any integer greater then zero. Indicates the number of columns, for 'VERTICAL' orientation there will always be a single column.

ThumbnailPosition

Possible values are 'TOP' or 'LEFT'. Indicates whether the product image will be displayed on top of product details or on the left.

PrintMyOrderPage

Summary:  Customer account page to display a printable version of order details.

Usage: [[ConLib:PrintMyOrderPage]]

ProductAccessoriesGrid

Summary:  Display product accessories of a product. This page will be displayed when a product that has accessories is added to cart.

Usage: [[ConLib:ProductAccessoriesGrid Caption="Products Accessories for {0}" Size="6" Columns="2"]]

Properties:

Caption

Possible value can be any string. Title of the control.

Size

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Columns

Possible value cab be any integer greater then zero. Indicates the number of columns.

ProductAssets

Summary:  Display additional details of assets of a product like digital goods, read me files and license agreements.

Usage: [[ConLib:ProductAssets Caption="Additional Details"]]

Properties:

Caption

Possible value can be any string. Title of the control.

ProductCustomFieldsDialog

Summary:  Display a list of custom fields of a product.

Usage: [[ConLib:ProductCustomFieldsDialog]]

ProductDescription

Summary:  A control to display product descriptions.

Usage: [[ConLib:ProductDescription DescriptionCaption="Description" MoreDetailCaption="More Details" ShowCustomFields="false"]]

Properties:

DescriptionCaption

Possible value can be any string. Caption for description.

MoreDetailCaption

Possible value can be any string. Caption for more details.

ShowCustomFields

Possible values are true or false. Indicates whether the CustomFields will be shown or not.

ProductDiscountsDialog

Summary:  Display all the discounts that can be applicable on selected product.

Usage: [[ConLib:ProductDiscountsDialog Caption="Available Discounts"]]

Properties:

Caption

Possible value can be any string. Title of the control.

ProductImage

Summary:  Displays one of the specified product image.

Usage: [[ConLib:ProductImage ShowImage="Thumbnail"]]

Properties:

ShowImage

Possible values are 'Thumbnail' or 'Icon' or 'Image'. Indicates which product image should be displayed.

ProductRatingImage

Summary:  Displays product rating image dynamically based on the product rating.

Usage: [[ConLib:ProductRatingImage]]

ProductReviewForm

Summary:  Displays a form using that a customer can submit/edit a review for a product.

Usage: [[ConLib:ProductReviewForm]]

ProductReviewsPanel

Summary:  Displays all reviews for a product.

Usage: [[ConLib:ProductReviewsPanel]]

ProductReviewTerms

Summary:  Display terms and conditions for the reviews submitting.

Usage: [[ConLib:ProductReviewTerms]]

ProductTellAFriend

Summary:  Display product a friend form, using that an email can be send to a friend about a specific product. This form can be added to side bars.

Usage: [[ConLib:ProductTellAFriend Caption="Email A Friend"]]

Properties:

Caption

Possible value can be any string. Title of the control.

ReadmeContent

Summary:  Display contents of a read me file.

Usage: [[ConLib:ReadmeContent]]

ReceiptPage

Summary:  Display page to show details of an order like order items, shipping address, billing address etc.

Usage: [[ConLib:ReceiptPage AllowAddNote="true" HandleFailedPayments="false"]]

Properties:

AllowAddNote

If true, the customer can add notes to the order. If false, the customer can only see notes added by the merchant.

HandleFailedPayments

If true, the customer is redirected to an order payment page if the payment fails at checkout.

RecentlyViewed

Summary:  Displays a list or grid of recently viewed products.

Usage: [[ConLib:RecentlyViewed Caption="Featured Items" MaxItems="5" Orientation="HORIZONTAL" Columns="3" ThumbnailPosition="TOP"]]

Properties:

Caption

Possible value can be any string. Title of the control.

MaxItems

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

Columns

Possible value can be any integer greater then zero. Indicates the number of columns, for 'VERTICAL' orientation there will always be a single column.

ThumbnailPosition

Possible values are 'TOP' or 'LEFT'. Indicates whether the product image will be displayed on top of product details or on the left.

RegisterDialog

Summary:  Display a form using that a new customer can register for a new account.

Usage: [[ConLib:RegisterDialog]]

RelatedProducts

Summary:  Displays a list or grid of recently viewed products.

Usage: [[ConLib:RelatedProducts Caption="Featured Items" MaxItems="5" Orientation="HORIZONTAL" Columns="3"]]

Properties:

Caption

Possible value can be any string. Title of the control.

MaxItems

Possible value cab be any integer greater then zero. Indicates that at maximum how many items can be shown.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

Columns

Possible value can be any integer greater then zero. Indicates the number of columns, for 'VERTICAL' orientation there will always be a single column.

RepeatOrderDialog

Summary:  A control which have a reorder button, that can be used to reorder the contents of an existing order.

Usage: [[ConLib:RepeatOrderDialog Caption="Repeat Order"]]

Properties:

Caption

Possible value can be any string. Title of the control.

SearchPage

Summary:  A page which shows search form and results in a grid.

Usage: [[ConLib:SearchPage]]

SendWishListPage

Summary:  Displays a form using that a wishlist link can be sent to a friend email address.

Usage: [[ConLib:SendWishListPage]]

SetWishlistPassword

Summary:  Displays a form using that a customer can set password for his wishlist.

Usage: [[ConLib:SetWishlistPassword]]

ShipAddressPage

Summary:  Display page where a customer can select a shipping address, or define multiple shipments and can select their respective addresses.

Usage: [[ConLib:ShipAddressPage]]

ShipMethodPage

Summary:  The page displays cart contents and all the applicable shipping methods available for those with shipping rates. Customer selects a shipping method for each shipment using this page.

Usage: [[ConLib:ShipMethodPage ShowWeight="true"]]

Properties:

ShowWeight

Possible values are true or false. Indicates whether the shipping address should be displayed with each item or not.

ShipMultiPage

Summary:  Display page to select multiple shipping addresses for each of shipment.

Usage: [[ConLib:ShipMultiPage]]

SimilarProducts

Summary:  Displays a list or grid of similar products.

Usage: [[ConLib:SimilarProducts Caption="Similar Products" Orientation="HORIZONTAL" Columns="3"]]

Properties:

Caption

Possible value can be any string. Title of the control.

Orientation

Possible values are 'HORIZONTAL' or 'VERTICAL'. Indicates whether the contents will be displayed vertically or horizontally, In case of vertical orientation only one column will be displayed.

Columns

Possible value cab be any integer greater then zero. Indicates the number of columns, for 'VERTICAL' orientation there will always be a single column.

SimpleCategoryList

Summary:  A simple category list which shows the nested categories under a specific category.

Usage: [[ConLib:SimpleCategoryList CssClass="section" HeaderCssClass="header" HeaderText="Categories" ContentCssClass="content"]]

Properties:

CssClass

Css style sheet class.

HeaderCssClass

Css style sheet class.

HeaderText

Title Text for the header.

ContentCssClass

Css style sheet class.

SimpleSearch

Summary:  Displays a simple search box where search keywords can be entered, for results the customer will be redirected to search page.

Usage: [[ConLib:SimpleSearch]]

StoreLogo

Summary:  Displays the store logo.

Usage: [[ConLib:StoreLogo]]

SubscribeToEmailList

Summary:  Displays a simple email list signup form. This form can be added to side bars.

Usage: [[ConLib:SubscribeToEmailList Caption="Subscribe To Email List" EmailListId="0"]]

Properties:

Caption

Possible value can be any string. Title of the control.

EmailListId

Possible value can be any integer. This is the ID of the Email List to be subscribed to. If no email list is specified the store's default email list is used.

SubscriptionPage

Summary:  Simple subscription pages where customer subscribe to emailing lists are confirmed

Usage: [[ConLib:SubscriptionPage SubscribedMessage="Your subscription to the list {0} has been activated." DeletedMessage="Your address has been removed from the list {0}." InvalidMessage="The subscription request was not understood or the provided parameters are incorrect."]]

Properties:

SubscribedMessage

Successful subscription message.

DeletedMessage

Successfu subscription removed message.

InvalidMessage

Invalid access message.

UserCurrencyDropDown

Summary:  Ajax enabled simple dropdown control to select a preferred currency.

Usage: [[ConLib:UserCurrencyDropDown]]

UserCurrencyMenuDropDown

Summary:  A simple dropdown control to select a preferred currency.

Usage: [[ConLib:UserCurrencyMenuDropDown]]

Utility\BasketItemDetail

Summary:  Shows details of a product which is currently in basket.

Usage: [[ConLib:Utility\BasketItemDetail LinkProducts="false" ShowShipTo="false" ShowAssets="false" ShowSubscription="true"]]

Properties:

LinkProducts

Possible values are true or false. Indicates whether the basket items should have a link to the product page or not.

ShowShipTo

Possible values are true or false. Indicates whether the shipping address should be displayed with each item or not.

ShowAssets

Possible values are true or false. Indicates whether the assets like readme files and licence agrements will be shown or not.

ShowSubscription

Possible values are true or false. Indicates whether subscriptions information whill be shown or not.

Utility\GiftWrapOptions

Summary:  Shows details of gift wrap options available for each product.

Usage: [[ConLib:Utility\GiftWrapOptions GiftMessage=""]]

Properties:

GiftMessage

Possible value can be any string message. Any pre-initialized message for gift wraps that customer can modify.

Utility\MiniBasketItemDetail

Summary:  Shows details of a single product which is currently in basket. Used to display details in minibasket control for all items.

Usage: [[ConLib:Utility\MiniBasketItemDetail LinkProducts="false" ShowShipTo="false" ShowAssets="false" ShowSubscription="false"]]

Properties:

LinkProducts

Possible values are true or false. Indicates whether the basket items should have a link to the product page or not.

ShowShipTo

Possible values are true or false. Indicates whether the shipping address should be displayed with each item or not.

ShowAssets

Possible values are true or false. Indicates whether the assets like readme files and license agreements will be shown or not.

ShowSubscription

Possible values are true or false. Indicates whether subscriptions information will be shown or not.

Utility\OrderItemDetail

Summary:  Shows detials of an order item.

Usage: [[ConLib:Utility\OrderItemDetail LinkProducts="false" ShowShipTo="false" ShowAssets="false"]]

Properties:

LinkProducts

Possible values are true or false. Indicates whether the basket items should have a link to the product page or not.

ShowShipTo

Possible values are true or false. Indicates whether the shipping address should be displayed with each item or not.

ShowAssets

Possible values are true or false. Indicates whether the assets like readme files and license agreements will be shown or not.

Utility\PayPalPayNowButton

Summary:  A buy now/checkout button for paypal.

Usage: [[ConLib:Utility\PayPalPayNowButton]]

Utility\PickerAndCalendar

Summary:  A utility calendar tool to select a date.

Usage: [[ConLib:Utility\PickerAndCalendar]]

Utility\PriceWithTax

Summary:  Displays price with tax included.

Usage: [[ConLib:Utility\PriceWithTax]]

Utility\ProductPrice

Summary:  Displays price without tax.

Usage: [[ConLib:Utility\ProductPrice]]

VerifyEmail

Summary:  Displays an email verification page.

Usage: [[ConLib:VerifyEmail SuccessMessage="Your email address has been verified!" FailureMessage="Your email address could not be verified. Check that you have opened the link exactly as it appeared in the verification notice."]]

Properties:

SuccessMessage

Success message.

FailureMessage

Failure message.

ViewWishlistPage

Summary:  Display other customers wishlist.

Usage: [[ConLib:ViewWishlistPage Caption="{0}'s Wishlist"]]

Properties:

Caption

Possible value can be any string. Title of the control.

WishlistSearch

Summary:  A search form to find wishlists of other customers.

Usage: [[ConLib:WishlistSearch]]

 

 

 

 Related Topics

Back to Top

Go to Site Map