Difference between revisions of "NVelocity variables available in scriptlets"

From AbleCommerce Wiki
Jump to: navigation, search
(Eliminate legacy parameter names.)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
Following will be available on the product details page
+
<div id="warning" style="text-align: center; background: #ffffee; margin: .75em 10%; padding: .5em; border: 2px solid #ffc3b0;">
 +
<span style="color: red">'''WARNING'''</span>
 +
Use NVelocity to only control the layout. Don't use it as a programming alternative otherwise it will slow down your pages. If you want to customize some logic then its better to modify the ConLib controls or create new controls to meet your requirements.
 +
</div>
  
−
store
 
  
−
customer
+
The following nVelocity variables are available in scriptlets. Some variables are available only in a particular context.
  
−
page
+
{| {{Prettytable}}
 +
|- {{Hl3}}
 +
!Variable!!Type!!Comments
 +
|-
 +
|$store||CommerceBuilder.Stores.Store||Reference to the current store. Available for all pages
 +
|-
 +
|$customer||CommerceBuilder.Users.User||Reference to the current user. Available for all pages
 +
|-
 +
|$page ||System.Web.UI.Page||The ASP.NET page object. Available for all pages
 +
|-
 +
|$Category ||CommerceBuilder.Catalog.Category||Category object is available on category, product, webpage and link display pages and wherever a CategoryId parameter is available in URL.
 +
|-
 +
|$Product ||CommerceBuilder.Products.Product||Product object is available on product display pages and wherever a ProductId is available in URL.
 +
|-
 +
|$Webpage ||CommerceBuilder.Catalog.Webpage||Webpage object is available on webpage display pages and wherever a WebpageId is available in URL.
 +
|-
 +
|$Link ||CommerceBuilder.Catalog.Link||Link object is available on link display pages and wherever a LinkId is available in URL.
 +
|}
  
−
Store
+
In the scriptlet code you can access almost anything using the above objects. For example if you want to get the Orders for current user then $customer.Orders will provide you that information etc. However it is '''strongly discouraged''' to use nVelocity scriptlets for anything other than controlling the display layout.
  
−
User
+
== Common Properties ==
  
−
Category
+
A sample of some of the properties commonly accessed is shown in the table below.  For a full listing of all object properties, see the [[CommerceBuilder_API‎|API]].
  
−
Product
+
{| {{Prettytable}}
 +
|- {{Hl3}}
 +
!Type!!Property!!Usage
 +
|-
 +
|CommerceBuilder.Users.User||UserName||$customer.UserName
 +
|-
 +
|CommerceBuilder.Users.User||Email||$customer.Email
 +
|-
 +
|CommerceBuilder.Users.User||PrimaryAddress.FirstName||$customer.PrimaryAddress.FirstName
 +
|-
 +
|CommerceBuilder.Users.User||PrimaryAddress.LastName||$customer.PrimaryAddress.LastName
 +
|-
 +
|CommerceBuilder.Users.User||PrimaryAddress.FullName||$customer.PrimaryAddress.FullName
 +
|-
 +
|CommerceBuilder.Users.User||PrimaryAddress.Phone||$customer.PrimaryAddress.Phone
 +
|}
 +
 
 +
== External Links ==
 +
* [http://www.castleproject.org/others/nvelocity/ NVelocity (castleroject)]
 +
* [http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html User Guide (velocity)]

Latest revision as of 16:21, 1 March 2012

WARNING Use NVelocity to only control the layout. Don't use it as a programming alternative otherwise it will slow down your pages. If you want to customize some logic then its better to modify the ConLib controls or create new controls to meet your requirements.


The following nVelocity variables are available in scriptlets. Some variables are available only in a particular context.

Variable Type Comments
$store CommerceBuilder.Stores.Store Reference to the current store. Available for all pages
$customer CommerceBuilder.Users.User Reference to the current user. Available for all pages
$page System.Web.UI.Page The ASP.NET page object. Available for all pages
$Category CommerceBuilder.Catalog.Category Category object is available on category, product, webpage and link display pages and wherever a CategoryId parameter is available in URL.
$Product CommerceBuilder.Products.Product Product object is available on product display pages and wherever a ProductId is available in URL.
$Webpage CommerceBuilder.Catalog.Webpage Webpage object is available on webpage display pages and wherever a WebpageId is available in URL.
$Link CommerceBuilder.Catalog.Link Link object is available on link display pages and wherever a LinkId is available in URL.

In the scriptlet code you can access almost anything using the above objects. For example if you want to get the Orders for current user then $customer.Orders will provide you that information etc. However it is strongly discouraged to use nVelocity scriptlets for anything other than controlling the display layout.

Common Properties

A sample of some of the properties commonly accessed is shown in the table below. For a full listing of all object properties, see the API.

Type Property Usage
CommerceBuilder.Users.User UserName $customer.UserName
CommerceBuilder.Users.User Email $customer.Email
CommerceBuilder.Users.User PrimaryAddress.FirstName $customer.PrimaryAddress.FirstName
CommerceBuilder.Users.User PrimaryAddress.LastName $customer.PrimaryAddress.LastName
CommerceBuilder.Users.User PrimaryAddress.FullName $customer.PrimaryAddress.FullName
CommerceBuilder.Users.User PrimaryAddress.Phone $customer.PrimaryAddress.Phone

External Links

Retrieved from "http://wiki.ablecommerce.com/index.php?title=NVelocity_variables_available_in_scriptlets&oldid=934"