Class Renderer
- Namespace
- Dynamicweb.Ecommerce.Frontend
- Assembly
- Dynamicweb.Ecommerce.dll
- Inheritance
-
Renderer
- Inherited Members
Constructors
Renderer()
Initializes a new instance of the class.
Renderer(PageView)
Initializes a new instance of the class.
Parameters
Renderer(PageView, int)
Initializes a new instance of the class.f
Parameters
Properties
ContentModule
Gets or sets the content module.
Property Value
IsOrderRendering
Gets or sets the value indicating whether need to render the order.
Property Value
PageView
Gets or sets the Page
Property Value
ParagraphId
Gets or sets the paragraph id.
Property Value
ParagraphSettings
Gets or sets the Product
Property Value
Methods
ForcePageId(int)
Forces the page id.
Parameters
pageId
intThe page id.
GetDiscountMatrix(PriceContext, string, long, Product)
Gets the product discount matrix
public DiscountInfoCollection GetDiscountMatrix(PriceContext context, string unitId, long stockLocationId, Product product)
Parameters
context
PriceContext Price context
unitId
stringUnit identifier
stockLocationId
longStock location identifier
product
Product
Returns
InitializeImagePatternSettings(string)
Initialize settings to render product's alternative images
Parameters
imagePatternProductCatalog
stringThe URL of product catalog with image patterns
Pid()
Gets the "PID=" URL segment.
Returns
RenderBoughtFromDateTags(Template, DateTime)
Renders the orders from specified date.
Parameters
RenderCountries(CountryCollection, Template, string)
Renders the countries.
public static void RenderCountries(CountryCollection countryCollection, Template parentTemplate, string loopName)
Parameters
countryCollection
CountryCollection The countries.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderCountry(Country, Template)
Renders the country.
Parameters
RenderCurrencies(Template)
Renders all currencies on the site.
Parameters
RenderCurrency(Currency, Template, string)
Renders the currency.
Parameters
currency
CurrencyThe currency.
template
TemplateThe Template.
tagName
stringName of the prefix of the tag, i.e. 'Currency' in the tag Currency.Code.
RenderCustomFields(Template, string)
Renders the custom fields.
Parameters
RenderCustomGroupField(ProductFieldValueCollection, Template)
Renders the custom fields.
public void RenderCustomGroupField(ProductFieldValueCollection productFieldValues, Template template)
Parameters
productFieldValues
ProductField Value Collection The custom fields.
template
TemplateThe Template.
RenderCustomProductField(Product, Template)
Renders the custom field.
Parameters
RenderDetail(Detail, Template)
Render the detail.
Parameters
RenderDetails(IEnumerable<Detail>, Template, string)
Renders the details.
Parameters
details
IEnumerable<Detail>The details.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderGiftCards(IEnumerable<GiftCard>, Template)
Render bought gift cards products.
Parameters
giftCards
IEnumerable<GiftCard >The gift cards.
parentTemplate
TemplateThe Template.
RenderGroup(Group, Template)
Renders single group.
Parameters
RenderGroup(Group, Template, bool)
Renders single group.
Parameters
group
GroupGroup to render.
template
TemplateThe Template.
renderSubGroups
boolIndicates whether to render sub-groups (if the corresponding loop is defined in a template).
RenderGroupCategory(Group, Template)
Renders group categories.
Parameters
RenderGroupTemplateExtenders(Group, Template)
Extends a Group template with TemplateExtenders
Parameters
RenderGroups(IEnumerable<Group>)
Renders the groups.
Parameters
groups
IEnumerable<Group>The groups.
Returns
- string
The HTML.
RenderGroups(IEnumerable<Group>, Template, string)
Renders the groups.
Parameters
groups
IEnumerable<Group>The groups.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderOrder(Order, Template)
Renders the order.
Parameters
RenderOrder(Order, Template, bool, int)
Renders the order.
Parameters
order
OrderThe order.
template
TemplateThe Template.
extendedProperties
boolIf set to
true
, renders with the extended properties.stepNumber
intThe step number.
RenderOrderContext(OrderContext, Template, string)
Renders the orderContext.
Parameters
orderContext
OrderContext The orderContext.
template
TemplateThe Template.
tagName
stringName of the prefix of the tag, i.e. 'OrderContext' in the tag OrderContext.Name.
RenderOrderContexts(Template)
Renders all order contexts on the site.
Parameters
RenderOrderDetails(Template, Order, bool)
Renders the order detail.
Parameters
template
TemplateThe Template.
order
OrderThe order.
extendedProperties
boolIf set to
true
, renders with the extended properties.
RenderOrderDetails(Template, Order, bool, OrderTemplateExtenderContext)
Renders the order details.
public void RenderOrderDetails(Template template, Order order, bool extendedProperties, OrderTemplateExtenderContext orderContext)
Parameters
template
TemplateThe Template.
order
OrderThe order.
extendedProperties
boolIf set to
true
, renders with the extended properties.orderContext
OrderTemplate Extender Context The order context.
RenderOrderFieldValues(Order, ref Template)
Renders the order fields.
Parameters
RenderOrderLine(OrderLine, Template)
Renders the order line.
Parameters
RenderOrderLineTemplateExtenders(Order, OrderLine, Template, TemplateExtenderRenderingState)
Extends a Cart template with TemplateExtenders
public void RenderOrderLineTemplateExtenders(Order order, OrderLine orderLine, Template template, TemplateExtenderRenderingState renderingState)
Parameters
order
OrderThe currently rendered Order
orderLine
OrderLine The currently rendered OrderLine
template
TemplateThe Template.
renderingState
TemplateExtender Rendering State
RenderOrderLines(OrderLineCollection, Template, string)
Renders the order lines.
public void RenderOrderLines(OrderLineCollection orderLines, Template parentTemplate, string loopName)
Parameters
orderLines
OrderLine Collection The order lines.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderOrderTaxes(OrderLineCollection, Template)
Render order taxes.
Parameters
orderLines
OrderLine Collection The order lines.
template
TemplateThe Template.
RenderOrderTemplateExtenders(Order, Template, TemplateExtenderRenderingState)
Extends a Order template with TemplateExtenders.
public static void RenderOrderTemplateExtenders(Order order, Template template, TemplateExtenderRenderingState renderingState)
Parameters
order
OrderThe currently rendered Order.
template
TemplateThe Template.
renderingState
TemplateExtender Rendering State
RenderOrderTemplateExtenders(Order, Template, TemplateExtenderRenderingState, int)
Extends an Order with TemplateExtenders.
public static void RenderOrderTemplateExtenders(Order order, Template template, TemplateExtenderRenderingState renderingState, int paragraphId)
Parameters
order
OrderThe order.
template
TemplateThe Template.
renderingState
TemplateExtender Rendering State The rendering state.
paragraphId
intThe paragraph id.
RenderPriceInfo(IPriceInfo, Template, string)
Renders the price information.
Parameters
price
IPriceInfo The price.
template
TemplateThe Template.
tagName
stringThe template tag name.
RenderProduct(Product, bool)
Renders the product.
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.
Returns
- string
The HTML.
RenderProduct(Product, bool, Template)
Renders the product.
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
RenderProduct(Product, bool, Template, int)
Renders the product.
public void RenderProduct(Product product, bool extendedProperties, Template template, int loopCounter)
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
loopCounter
intThe loop counter.
RenderProduct(Product, bool, Template, int, bool, int)
Renders the product.
public void RenderProduct(Product product, bool extendedProperties, Template template, int loopCounter, bool renderRelated, int orderLineOfProductCount = 0)
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
loopCounter
intThe loop counter.
renderRelated
boolIs set to
true
, renders related products.orderLineOfProductCount
intThe order line.
RenderProduct(Product, bool, Template, int, bool, string)
Renders the product.
public void RenderProduct(Product product, bool extendedProperties, Template template, int loopCounter, bool renderRelated, string productUrl)
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
loopCounter
intThe loop counter.
renderRelated
boolIs set to
true
, renders related products.productUrl
stringThe product URL.
RenderProduct(Product, bool, Template, int, bool, string, int, int)
Renders the product.
public void RenderProduct(Product product, bool extendedProperties, Template template, int loopCounter, bool renderRelated, string productUrl, int quantity, int wishListId)
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
loopCounter
intThe loop counter.
renderRelated
boolIs set to
true
, renders related products.productUrl
stringThe product URL.
quantity
intThe quantity.
wishListId
intThe wishlist id.
RenderProduct(Product, bool, Template, int, bool, string, int, int, bool, int)
Renders the product.
public void RenderProduct(Product product, bool extendedProperties, Template template, int loopCounter, bool renderRelated, string productUrl, int quantity, int wishListId, bool renderPublicList, int orderLineOfProductCount = 0)
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.template
TemplateThe Template.
loopCounter
intThe loop counter.
renderRelated
boolIs set to
true
, renders related products.productUrl
stringThe product URL.
quantity
intThe quantity.
wishListId
intThe wishlist id.
renderPublicList
boolIf set to
true
it is public list.orderLineOfProductCount
intThe order line.
RenderProduct(Product, bool, string)
Renders the product.
Parameters
product
ProductThe product.
extendedProperties
boolIf set to
true
, renders with the extended properties.unitId
string
Returns
- string
The HTML.
RenderProductCategories(Product, Template, string)
Renders product categories.
Parameters
product
ProductProduct whose categories shold be rendered.
template
TemplateThe Template.
loopName
stringThe name of the template loop.
RenderProductCategoryFields(Product, Category, Template, string)
Renders product category field values from the specified category.
public void RenderProductCategoryFields(Product product, Category category, Template template, string loopName)
Parameters
product
ProductProduct whose category field values needs to be rendered.
category
CategoryProduct category.
template
TemplateThe Template.
loopName
stringThe name of the loop within the template.
RenderProductCustomFieldValues(ProductFieldValueCollection, Template, string)
Renders the custom fields.
public void RenderProductCustomFieldValues(ProductFieldValueCollection productFieldValues, Template parentTemplate, string loopName)
Parameters
productFieldValues
ProductField Value Collection The custom fields.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderProductCustomFields(ProductFieldValueCollection, Template, string)
Renders the custom fields.
public void RenderProductCustomFields(ProductFieldValueCollection productFieldValues, Template parentTemplate, string loopName)
Parameters
productFieldValues
ProductField Value Collection The custom fields.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderProductGroupCustomFields(ProductGroupFieldValueCollection, Template, string)
Renders the custom fields.
public void RenderProductGroupCustomFields(ProductGroupFieldValueCollection productGroupFieldValues, Template parentTemplate, string loopName)
Parameters
productGroupFieldValues
ProductGroup Field Value Collection The custom fields.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderProductGroupCustomFields(string, ProductGroupFieldValueCollection, Template, string)
Renders the custom fields.
public void RenderProductGroupCustomFields(string languageId, ProductGroupFieldValueCollection productGroupFieldValues, Template parentTemplate, string loopName)
Parameters
languageId
stringThe language id.
productGroupFieldValues
ProductGroup Field Value Collection The custom fields.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderProductGroups(Template)
Renders the product groups.
Parameters
RenderProductListTemplateExtenders(ProductCollection, Template)
Extends a ProductList template with TemplateExtenders.
Parameters
products
ProductCollection The currently rendered product.
template
TemplateThe Template.
RenderProductManufacturer(Manufacturer, Template)
Renders the product manufacturer.
Parameters
manufacturer
ManufacturerThe product manufacturer.
template
TemplateThe Template.
RenderProductRelatedGroups(Product, Template, string)
Renders the related products groups.
Parameters
RenderProductTaxes(OrderLineCollection, OrderLine, Template)
Render taxes for product.
public void RenderProductTaxes(OrderLineCollection orderLines, OrderLine orderLine, Template template)
Parameters
orderLines
OrderLine Collection The order lines.
orderLine
OrderLine The order line.
template
TemplateThe Template.
RenderProductTemplateExtenders(Product, Template)
Extends a product template with TemplateExtenders.
Parameters
RenderProductTemplateExtenders(Product, Template, bool)
Extends a Product template with TemplateExtenders.
public void RenderProductTemplateExtenders(Product product, Template template, bool extendedProperties)
Parameters
product
ProductThe currently rendered product
template
TemplateThe Template.
extendedProperties
boolIf set to
true
, renders with the extended properties.
RenderProducts(ProductCollection)
Renders the products.
Parameters
products
ProductCollection A collection of the products.
Returns
- string
The HTML.
RenderProducts(ProductCollection, Template)
Renders the products.
Parameters
products
ProductCollection A collection of the products.
parentTemplate
TemplateThe Template.
RenderProducts(ProductCollection, Template, string)
Renders the products.
Parameters
products
ProductCollection A collection of the products.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderProducts(ProductCollection, Template, string, int)
Renders the products.
public void RenderProducts(ProductCollection products, Template parentTemplate, string loopName, int loopCounter)
Parameters
products
ProductCollection A collection of the products.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
loopCounter
intThe loop counter.
RenderProductsSimpleWithQuantity(Dictionary<Product, int>, Template, int)
Renders the products with the quantity.
public void RenderProductsSimpleWithQuantity(Dictionary<Product, int> productDictionary, Template template, int wishListId)
Parameters
productDictionary
Dictionary<Product, int>A dictionary of the products and quantity.
template
TemplateThe Template.
wishListId
intThe wishlist id.
RenderRma(ReturnMerchandiseAuthorization, Template, string, bool, bool, bool)
Renders the RMA.
public void RenderRma(ReturnMerchandiseAuthorization rma, Template template, string orderId, bool hasAddProductComment, bool hasAddContent, bool hasCancelContent)
Parameters
rma
ReturnMerchandise Authorization The rma.
template
TemplateThe Template.
orderId
stringThe order ID.
hasAddProductComment
boolif set to
true
render the has add product comment.hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaComment(ReturnMerchandiseAuthorizationComment, Template, bool, bool)
Renders the RMA comment.
public void RenderRmaComment(ReturnMerchandiseAuthorizationComment comment, Template template, bool hasAddContent, bool hasCancelContent)
Parameters
comment
ReturnMerchandise Authorization Comment The comment.
template
TemplateThe Template.
hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaComments(ReturnMerchandiseAuthorizationCommentCollection, Template, string, bool, bool)
Renders the RMA comments.
public void RenderRmaComments(ReturnMerchandiseAuthorizationCommentCollection comments, Template parentTemplate, string loopName, bool hasAddContent, bool hasCancelContent)
Parameters
comments
ReturnMerchandise Authorization Comment Collection The comments.
parentTemplate
TemplateThe Template.
loopName
stringName of the loop.
hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaDetails(Template, ReturnMerchandiseAuthorization, string, bool, bool, bool)
Renders the RMA details.
public void RenderRmaDetails(Template template, ReturnMerchandiseAuthorization rma, string orderId, bool hasAddProductComment, bool hasAddContent, bool hasCancelContent)
Parameters
template
TemplateThe Template.
rma
ReturnMerchandise Authorization The rma.
orderId
stringThe order ID.
hasAddProductComment
boolif set to
true
has add product comment.hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaHasContent(Template, bool, bool)
Renders the RMA tags HasAddContent and HasCancelContent.
Parameters
template
TemplateThe Template.
hasAddContent
boolif set to
true
render the HasAddContent tag.hasCancelContent
boolif set to
true
render the HasCancelContent tag.
RenderRmaOrderLine(ReturnMerchandiseAuthorizationOrderLine, int, Template, bool, bool, bool)
Renders the RMA order line.
public void RenderRmaOrderLine(ReturnMerchandiseAuthorizationOrderLine rmaOrderLine, int prefixId, Template template, bool hasAddProductComment, bool hasAddContent, bool hasCancelContent)
Parameters
rmaOrderLine
ReturnMerchandise Authorization Order Line The rma order line.
prefixId
intThe preffix id.
template
TemplateThe Template.
hasAddProductComment
boolif set to
true
has add product comment.hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaOrderLines(ReturnMerchandiseAuthorizationOrderlineCollection, Template, string, bool, bool, bool)
Renders the RMA order lines.
public void RenderRmaOrderLines(ReturnMerchandiseAuthorizationOrderlineCollection rmaOrderLines, Template parentTemplate, string loopName, bool hasAddProductComment, bool hasAddContent, bool hasCancelContent)
Parameters
rmaOrderLines
ReturnMerchandise Authorization Orderline Collection The rma order lines.
parentTemplate
TemplateThe Template.
loopName
stringName of the loop.
hasAddProductComment
boolif set to
true
has add product comment.hasAddContent
boolif set to
true
has add content.hasCancelContent
boolif set to
true
has cancel content.
RenderRmaTypes(int, List<KeyValuePair<ReturnMerchandiseAuthorizationType, string>>, Template, string)
Renders the RMA types.
public void RenderRmaTypes(int selectedTypeId, List<KeyValuePair<ReturnMerchandiseAuthorizationType, string>> types, Template parentTemplate, string loopName)
Parameters
selectedTypeId
intThe selected type ID.
types
List<KeyValue <ReturnPair Merchandise , string>>Authorization Type The types.
parentTemplate
TemplateThe Template.
loopName
stringName of the loop.
RenderSearchTemplate()
Renders the search template.
Returns
- string
The HTML.
RenderShippingTaxes(OrderLineCollection, Template)
Render taxes for shipping
Parameters
orderLines
OrderLine Collection The order lines.
template
TemplateThe Template.
RenderStockLocations(Product, Template, string, bool)
Renders the stock locations.
public void RenderStockLocations(Product product, Template template, string currentUnitId, bool isRenderInternalLoop)
Parameters
product
ProductThe product.
template
TemplateThe Template.
currentUnitId
stringThe unit id.
isRenderInternalLoop
boolIf set to
true
renders the internal loop.
RenderStockStateTotals(Product, Template)
Renders the totals for stock state.
Parameters
RenderStockStatus(StockStatus, Template, string)
Renders stock status.
Parameters
stockStatus
StockStatus The stock status.
template
TemplateThe Template.
languageId
string
RenderStockUnits(Product, Template, StockLocation, bool)
Renders stock stockUnits.
public void RenderStockUnits(Product product, Template template, StockLocation currentStockLocation, bool isRenderInternalLoop)
Parameters
product
ProductThe product.
template
TemplateThe Template.
currentStockLocation
StockLocation The stock location.
isRenderInternalLoop
boolIf set to
true
renders the internal loop.
RenderUnit(Unit, Template)
Renders the unit.
Parameters
RenderUnits(Product, Template)
Renders stockUnits.
Parameters
RenderVariantAvailableOptions(Product, IEnumerable<VariantOption>, Template, string)
Renders the available variant options.
public void RenderVariantAvailableOptions(Product product, IEnumerable<VariantOption> groupVariantOptions, Template parentTemplate, string loopName)
Parameters
product
ProductThe product.
groupVariantOptions
IEnumerable<VariantOption >The variant options.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
RenderVariantAvailableOptions(Product, IEnumerable<VariantOption>, Template, string, bool)
Renders the available variant options.
public void RenderVariantAvailableOptions(Product product, IEnumerable<VariantOption> groupVariantOptions, Template parentTemplate, string loopName, bool isCalledInsideRecursion)
Parameters
product
ProductThe product.
groupVariantOptions
IEnumerable<VariantOption >The variant options.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.
isCalledInsideRecursion
bool
RenderVariantCombinations(Product, Template, string)
Renders the variant combinations.
Parameters
RenderVariantGroup(Product, VariantGroup, Template)
Renders the variant groups.
Parameters
product
ProductThe product.
variantGroup
VariantGroup The variant group.
template
TemplateThe Template.
RenderVariantGroups(Product, Template, string)
Renders the variant groups.
Parameters
RenderVariantOption(VariantOption, Template)
Renders the variant option.
Parameters
VariantOption
VariantOption The variant option.
Template
TemplateThe Template.
RenderVariantOption(VariantOption, Template, string)
Renders the variant option.
public void RenderVariantOption(VariantOption variantOption, Template template, string renderingVariantId)
Parameters
variantOption
VariantOption The variant option.
template
TemplateThe Template.
renderingVariantId
stringThe rendering variant id.
RenderVariantOptions(IEnumerable<VariantOption>, Template, string)
Renders the variant options.
public void RenderVariantOptions(IEnumerable<VariantOption> variantOptions, Template parentTemplate, string loopName)
Parameters
variantOptions
IEnumerable<VariantOption >The variant options.
parentTemplate
TemplateThe Template.
loopName
stringThe loop name.