Reference - Transformation methods

Eval

• string columnName
• bool encode

Loads the value from the specified column of the transformed object’s data. Returns the value as an object data type. Use only for ASCX transformations.

The optional boolean parameter specifies whether the method HTML encodes the loaded value. When not specified, the encoding depends on the value of the CMSHTMLEncodeEval web.config key (false by default).

<%# Eval(“NewsTitle”) %>
<%# Eval(“NewsTitle”, true) %>

Eval<ReturnType>

• string columnName

Loads the value from a column of the transformed object’s data, and returns it as an object of the specified type. Use only for ASCX transformations.

<%# Eval<string>(“NodeAliasPath”) %>

EvalCDATA

• string columnName
• bool encapsulate

Loads the value from the specified column of the transformed object’s data and escapes all occurrences of the ]]> sequence in the returned string.

Depending on the optional boolean parameter (true by default), the method wraps the whole string in the <![CDATA[“wrapped text”]]> enclosure.

<%# EvalCDATA(“NewsText”) %>
<%# EvalCDATA(“NewsText”, true) %>

EvalJSString

• string columnName

Loads the value from the specified column of the transformed object’s data. Encodes the returned text to be used in JavaScript code and encapsulates it into ’ characters.

GetEditableValue

• string controlId

Loads the content of an editable region on the page. Specify the region using the control ID (web part control ID).

<%# GetEditableValue(“mainText”) %>

GetNotEmpty

• object columnsOjb

Returns the value of the first data column that is not empty or null. The parameter must provide a list of column names separated by semicolons.

<%# GetNotEmpty(“FullName;UserName”) %>

GetColumnName

• string columns
• bool allowEmptyColumn

Returns the value of the first column that is present in the data of the transformed object. The parameter must provide a list of column names separated by semicolons.

By default, the method only returns columns that are not null or empty. Set the optional second parameter to true to allow empty values.

DataItem

Gets the currently transformed data item.

<%# DataItem %>

DataItemIndex

Gets the data item index for the current transformation container. You have to use Container.DataItemIndex to get the index in the current binding context.

<%# DataItemIndex %>

DataItemCount

Gets the total number of data items in the current transformation container. If pagination is used, the DataItemCount returns the number of items on the current page.

<%# DataItemCount %>

DataRowView

Gets a DataRowView of the transformed record’s data.

<%# DataRowView[“UserName”] %>

DisplayIndex

Gets the current position of the data item as displayed in a control.

<%# DisplayIndex %>

DocumentCustomData

Gets the value of custom page data fields (culture specific). Use the [“nodename”] notation to retrieve data stored in the specified node of the XML.

See also: Storing custom data for all page types

<%# DocumentCustomData[“myproperty”] %>

EditableItems

Gets the content of the specified editable region on the page.

<%# EditableItems[“mainText”] %>

NodeCustomData

Gets the value of custom page data fields (shared for all culture versions). Use the [“nodename”] notation to retrieve data stored in the specified node of the XML.

See also: Storing custom data for all page types

<%# NodeCustomData[“myproperty”] %>

If

• object value
• object trueResult
• object falseResult

Returns a result according to the boolean value of the first parameter.

<%# If(Eval(“IsSecuredNode”), “The page requires authentication”, “The page is publicly available”) %>

IfCompare

• object value
• object comparableValue
• object falseResult
• object trueResult

Compares the values of the first and the second parameter.

• If the parameters are different or are both null, the method returns the third parameter.
• If the parameters are equal, the fourth parameter is returned.

<%# IfCompare(1, 2, “The values are different”, “The values are equal”) %>

IfEmpty

• object value
• object emptyResult
• object nonEmptyResult

Checks for emptiness of the value in the first parameter.

• If the first parameter is null, the method returns the second parameter.
• If the first parameter is not null, the third parameter is returned.

<%# IfEmpty(Eval(“ProductPhoto”), “No image”, GetImage(“ProductPhoto”)) %>

IfTrue

• object value
• object trueResult

Checks whether the first parameter contains a true boolean value.

• If true, the method returns the second parameter.
• If false, an empty string is returned.

IsFirst

-

Returns a true value if the transformed data item is the first in the provided data. If pagination is used, the method returns a true value for the first item on the current page.

<%# IsFirst() %>

IsLast

-

Returns a true value if the transformed data item is the last in the provided data. If pagination is used, the method returns a true value for the last item on the current page.

<%# IsLast() %>

IsCurrentDocument

-

Returns a true value if the transformed page is equal to the page where the transformation is being displayed.

<%# IsCurrentDocument() %>

IsDocumentOnSelectedPath

-

Returns a true value if the transformed page is present on the alias path of the page where the transformation is being displayed (i.e. if the transformed page is an ancestor of the current page).

<%# IsDocumentOnSelectedPath() %>

GetAbsoluteUrl

• string relativeUrl
• int siteId
• object siteNameObj
• string domainName

Converts relative URLs to absolute URLs. You can specify the target domain name in the absolute URL using either a site ID, site code name or explicitly.

If you leave all optional parameters empty, the method generates the absolute URL using the domain of the current site.

<%# GetAbsoluteUrl(“~/Home.aspx”) %>
<%# GetAbsoluteUrl(“~/Home.aspx”, Eval<int>(“NodeSiteID”)) %>

GetAttachmentIcon

• object attachmentGuidColumn

Returns the attachment file type icon according to the extension of the file identified by the given GUID column.

<%# GetAttachmentIcon(“AttachmentGUID”) %>

GetAttachmentUrl

• object attachmentFileName
• object nodeAliasPath
• string variant

Returns the URL of the attachment file specified by name in the first parameter, loaded from the page whose alias path matches the second parameter. For example, you can use the method for working with grouped and unsorted attachments.

You can optionally generate a URL for an image variant of the attachment by specifying an image variant definition identifier.

The method returns the same URL as the GetAttachmentUrlByDocumentId method, but without loading the whole page, which results in better performance.

<%# GetAttachmentUrl(Eval(“AttachmentName”), Eval(“NodeAliasPath”)) %>

GetAttachmentUrlByDocumentId

• object attachmentFileName
• object attachmentDocumentId
• string variant

Returns the URL of the attachment file specified by name in the first parameter, loaded from the page whose ID matches the second parameter.

You can optionally generate a URL for an image variant of the attachment by specifying an image variant definition identifier.

<%# GetAttachmentUrlByDocumentId(Eval(“AttachmentFileName”), Eval(“AttachmentDocumentID”)) %>

GetAttachmentUrlByGUID

• object attachmentGuid
• object attachmentFileName
• string variant

Returns the URL of the attachment file specified by an attachment GUID value.

You can optionally generate a URL for an image variant of the attachment by specifying an image variant definition identifier.

The method’s file name parameter does not have to correspond with the real file name.

<%# GetAttachmentUrlByGUID(Eval(“AttachmentGUIDColumn”), “<custom_file_name>”) %>

GetDocumentLink

• bool encodeName

Returns a HTML link (<a> tag) that leads to the transformed page. By default, the method HTML encodes the page name in the link title. Set the optional parameter to false to disable the encoding.

<%# GetDocumentLink() %>
<%# GetDocumentLink(false) %>

GetDocumentUrl

Returns the URL of the specified page. The method does not evaluate custom URL extensions set for the page.

<%# GetDocumentUrl() %>

GetDocumentUrlById

• object documentIdObj

Returns the URL of the specified page. The method evaluates custom URL extensions set for the page if the system is set to use extensionless URLs.

<%# GetDocumentUrlById(Eval(“DocumentID”)) %>

GetDocumentUrlByGUID

• object nodeGuid
• object nodeAlias

Returns a permanent URL of the specified page (with the NodeGUID in the query string).

<%# GetDocumentUrlByGUID(Eval(“NodeGUID”), Eval(“NodeAlias”)) %>

GetFileIcon

• object fileExtension

Returns an <i> tag displaying a font icon that represents the MIME type of the specified file extension.

<%# GetFileIcon(Eval(“DocumentExtensions”)) %>

GetFileIconClass

• string extension

Returns the name of a CSS class, which you can use to display font icons representing the MIME type of the specified file extension. Assign the class to an <i> tag to display the icon.

<i class=“<%# GetFileIconClass(Eval<string>(”DocumentExtensions”)) %>“></i>

GetForumPostUrl

• object postIDPath
• object fourmID

Returns the URL of the forum post specified by the path in the first parameter, from the forum specified by the identifier in the second parameter.

<%# GetForumPostUrl(Eval(“PostIDPath”), Eval(“ForumID”)) %>

GetMediaFileUrl

• object fileGUID
• object fileName

Returns the URL of the specified media file. The media file is specified by the file GUID in the first parameter and the file name in the second parameter.

<%# GetMediaFileUrl(Eval(“FileGUID”), Eval(“FileName”)) %>

Note: GetMediaFileUrl requires different parameters when used as a macro method for Text / XML transformations:

• libraryId – the ID of the media library containing the file (the value in the media file’s FileLibraryID column).
• filePath – the file’s media library path and extension (the value in the media file’s FilePath column).
• fileGuid – the file’s GUID identifier (the value in the media file’s FileGuid column).
• fileName – the file’s name, without the extension (the value in the media file’s FileName column).
• useSecureLinks – true/false value indicating whether the link evaluates media library permissions.
• (optional) downloadLink – true/false value indicating whether the link forces a file download (i.e. uses the attachment content-disposition).

For example: {% GetMediaFileUrl(FileLibraryID, FilePath, FileGuid, FileName, true) %}

GetMetaFileUrl

• object fileGUID
• object fileName

Returns the URL of the specified meta file. The file is specified by the file GUID in the first parameter and the file name in the second parameter.

GetNavigationUrl

Returns a resolved (absolute) URL of the page that’s currently being processed. The resulting URL is not encoded. The method reflects page navigation settings, such as URL redirection, and Redirect to first child.

<%# GetNavigationUrl() %>

GetUrl

• object aliasPath
• object urlPath
• object siteName

Returns the URL of the page specified by the alias path in the first parameter or the URL path in the second parameter.

<%# GetUrl(Eval(“NodeAliasPath”), Eval(“DocumentUrlPath”)) %>
<%# GetUrl(Eval(“NodeAliasPath”), Eval(“DocumentUrlPath”), Eval(“SiteName”)) %>

EnsureMaximumLineLength

• object textObj
• int maxLength

Allows you to insert line breaks into long sequences of characters without whitespace (such as URLs). The method places the line break after the number of characters specified by the second parameter.

<%# EnsureMaximumLineLength(“VeryLongStringWithoutAnyBlankSpaces”, 21) %>

HTMLEncode

• string text

Encodes HTML tags in the specified text.

<%# HTMLEncode(“Sample text <br />”) %>

LimitLength

• object textObj
• int maxLength
• string padString
• bool wholeWords

Limits text to the length specified in the second parameter. The third parameter is the trimming suffix, i.e. the string appended to the end of shortened strings. The suffix is included in the maximum length. For example, if you use the “…” suffix and a maximum length of 100 characters, the returned string contains the first 97 characters of the original string, followed by an ellipsis.

Set the last parameter to true to avoid trimming in the middle of words.

<%# LimitLength(“Example of long text”, 10 , “…”, true) %>

Localize

• object text

Resolves all localization expressions inside the specified text.

RemoveDiscussionMacros

• object inputText

Removes all BBCode tags from the provided text.

<%# RemoveDiscussionMacros(“[quote]Sample text[/quote]”) %>

RemoveDynamicControls

• object inputText

Removes all controls from the specified text (such as inline widgets).

<%# RemoveDynamicControls(Eval(“NewsText”) ) %>

StripTags

• object inputText

Completely removes HTML tags from the specified text.

<%# StripTags(“Sample text <br />”) %>

GetEditableImage

• string controlId
• object maxSideSize
• object width
• object height
• object alt

Returns an image tag that displays the content of an editable image control or web part on the page. Specify the editable image using the control ID (web part control ID).

<%# GetEditableValue(“mainImage”) %>

GetEditableImageUrl

• string controlId

Returns the URL of the image selected inside the specified editable image control or web part. Specify the editable image using the control ID (web part control ID).

<%# GetEditableImageUrl(“mainImage”) %>

GetImage

• object attachmentGuidColumn
• object (int) maxSideSize
• object (int) width
• object (int) height
• object alt

Returns an image tag that displays the image file whose GUID is stored in the specified column of the transformed object’s data.

<%# GetImage(“NewsTeaser”) %>
<%# GetImage(“NewsTeaser”, 200) %>
<%# GetImage(“NewsTeaser”, 200, 100) %>
<%# GetImage(“NewsTeaser”, 200, 200, 100) %>
<%# GetImage(“NewsTeaser”, 200, 200, 100, “image alternate text”) %>

GetImageByUrl

• object imageUrl
• object (int) maxSideSize
• object (int) width
• object (int) height
• object alt

Returns an image tag that displays the image stored under the specified URL.

<%# GetImageByUrl(“~/Images/Image1.aspx”) %>
<%# GetImageByUrl(“~/Images/Image1.aspx”, 100, 200) %>
<%# GetImageByUrl(“~/Images/Image1.aspx”, 200) %>
<%# GetImageByUrl(“~/Images/Image1.aspx”, 200, 100, 200, “image alternate text”) %>

IfImage

• object attachmentGuidColumn
• object isImage
• object notImage

Checks whether the page attachment specified by the GUID in the first parameter is an image file. If the file is an image, the method returns the value of the second parameter, otherwise the value of the third parameter.

<%# IfImage(“NewsTeaser”, “The file is an image”, “The file is not an image”) %>

GetSKUPrice

-

Returns an SKU price based on the SKU data and the data of the current shopping cart.

The price includes any catalog discounts that apply.

<%# GetSKUPrice() %>

GetSKUFormattedPrice

-

Returns a formatted SKU price based on the SKU data and the data of the current shopping cart.

The price includes any catalog discounts that apply.

<%# GetSKUFormattedPrice() %>

GetSKUListPrice

-

Returns an SKU list price based on the SKU data and the data of the current shopping cart. The list price is loaded from the SKURetailPrice column.

<%# GetSKUListPrice() %>

GetSKUFormattedListPrice

-

Returns a formatted SKU list price based on the SKU data and the data of the current shopping cart. The list price is loaded from the SKURetailPrice column.

<%# GetSKUFormattedListPrice() %>

GetSKUOriginalPrice

-

Returns the greater of the following SKU price options:

• The product’s list price (from the SKURetailPrice column)
  – OR –
• The product’s price (from the SKUPrice column) without any discounts applied

If both prices are equal to the standard product price with discounts (i.e. the product’s list price is equal to the price and no discounts apply), the method returns 0.

<%# GetSKUOriginalPrice() %>

GetSKUFormattedOriginalPrice

-

Returns the greater of the following SKU price options and formats the result according to the currency used in the current shopping cart:

• The product’s list price (from the SKURetailPrice column)
  – OR –
• The product’s price (from the SKUPrice column) without any discounts applied

If both prices are equal to the standard product price with discounts (i.e. the product’s list price is equal to the price and no discounts apply), the method returns 0.

<%# GetSKUFormattedOriginalPrice() %>

GetSKUPriceSaving

• bool percentage

Returns the amount of money saved on the price of the processed SKU, as a percentage or in the currency of the current shopping cart.

The savings are calculated based on the difference between the product’s price (from the SKUPrice column, including any catalog discounts that apply) and the greater of the following options:

• The product’s list price (from the SKURetailPrice column)
  – OR –
• The product’s price (from the SKUPrice column) without any discounts applied

If the product’s price is greater than the list price and no discounts apply, the method returns 0.

The optional bool percentage parameter determines whether the result is returned as a percentage. By default the value is false, which means the result is returned in the currency of the current shopping cart.

<%# GetSKUPriceSaving(true) %>

GetSKUFormattedPriceSaving

-

Returns the amount of money saved on the price of the processed SKU and formats the result according to the currency used in the current shopping cart.

The savings are calculated based on the difference between the product’s price (from the SKUPrice column, including any catalog discounts that apply) and the greater of the following options:

• The product’s list price (from the SKURetailPrice column)
  – OR –
• The product’s price (from the SKUPrice column) without any discounts applied

If the product’s price is greater than the list price and no discounts apply, the method returns 0.

<%# GetSKUFormattedPriceSaving() %>

GetSKUTax

-

Depending on the site’s Prices include tax setting, returns either:

• The tax value that will be added to the processed SKU’s price during checkout (if prices do not include tax)
  – OR –
• The tax portion of the processed SKU’s price (if prices already include tax)

For example:

• Prices do not include tax, the SKU price is 50 and the applied tax rate is 5% – returns 2.5
• Prices include tax, the SKU price is 55 and the applied tax rate is 10% – returns 5

<%# GetSKUTax() %>

GetFormattedSKUTax

-

Displays a tax value for the processed SKU and formats the result according to the currency used in the current shopping cart. Depending on the site’s Prices include tax setting, returns either:

• The tax value that will be added to the processed SKU’s price during checkout (if prices do not include tax)
  – OR –
• The tax portion of the processed SKU’s price (if prices already include tax)

<%# GetFormattedSKUTax() %>

ApplyExchangeRate

• decimal price

Returns the specified price (decimal price) in the currency of the current user’s shopping cart and then converts the value into the current site’s main currency (according to the configured exchange rates).

<%# ApplyExchangeRate(100) %>

FormatPrice

• decimal price
• bool round

Returns the specified price (decimal price) formatted according to the currency of the current user’s shopping cart. The method does not work in contexts where the current shopping cart is not available.

• Set whether the price should be rounded (bool round) to the number of decimal fields specified in the current site’s currency settings. Price rounding is enabled by default if the round parameter is not specified.

<%# FormatPrice(100, true) %>

GetSKUIndicatorProperty

• string column

Returns a value from the specified column (string column) of the public status assigned to the transformed product. Commonly used public status columns are PublicStatusDisplayName and PublicStatusName.

If the product is evaluated as a new product, the public status is determined by thePublic status for ’new products’setting.

<%# GetSKUIndicatorProperty(“PublicStatusDisplayName”) %>

IsSKUAvailableForSale

-

Returns whether the given SKU can be bought by customers on the live site based on the properties of the SKU.

<%# IsSKUAvailableForSale() %>

IsSKUInStock

-

Returns whether the given SKU is available or not based on the stock amountproperty of the SKU.

<%# IsSKUInStock() %>

GetSKUNodeAlias

-

Returns the node alias of the given SKU. If there are multiple nodes for the SKU, the first occurrence is returned. If there is not any node for the SKU, an empty string is returned.

<%# GetSKUNodeAlias() %>

GetSKUUrl

-

Returns the user-friendly permanent URL of the SKU.

<%# GetSKUUrl() %>

GetProductUrl

• object (Guid) skuGuid
• object (string) skuName
• object (string) siteName

Returns the user-friendly URL of the product specified by the GUID (object skuGuid) and name (object skuName) of the product on the specified site (object siteName). If you do not specify the site name, the system uses the current site.

<%# GetProductUrl(Eval(“SkuGuid”), Eval(“SkuName”), Eval(“SiteName”)) %>

GetProductUrlById

• object (int) skuID
• object (string) skuName
• object (string) siteNameObj

Returns the user-friendly URL of the product specified by the ID (object skuID) and name (object skuName) of the product on the specified site (object siteName). If you do not specify the site name, the system uses the current site.

<%# GetProductUrlByID(Eval(“SkuID”), Eval(“SkuName”), Eval(“SiteName”)) %>

GetProductUrlForFeed

• object (Guid) skuGUID
• object (string) skuName
• object (string) siteName

Returns the URL of the specified product (object skuGUID) with the specified name (object skuName) with the feed query string parameter in the URL for the feed on the specified site (object siteName). If you do not specify the site name, the system uses the current site.

<%# GetProductUrlForFeed(Eval(“SkuGuid”), Eval(“SkuName”), Eval(“SiteName”)) %>

GetSKUImageUrl

• int width
• int height

OR

• int maxSideSize

Returns the URL of the product image. Specify the required width (object width) and height (object height) of the image, or the maximum side width of the image (object maxsidesize).

If the product image is not specified, the URL of the default product image is returned.

<%# GetSKUImageUrl(200, 300) %>

GetDiscountCouponCodeRemoveButton

• string couponCode
• string cssClass
• string buttonText

Available for transformations displaying coupon code items using the Coupon codes web part.

Generates an <input> element (of the submit type) that removes the specified coupon code from the shopping cart when clicked.

<%# GetDiscountCouponCodeRemoveButton(Eval<string>(“Code”), “btn”) %>

GetMultiBuyDiscountNames

-

Available for transformations displaying shopping cart items (for example using the Shopping cart content web part).

Returns the names and price values of Buy X Get Y discounts and Product coupons applied to the current shopping cart item, enclosed within li HTML tags.

<%# GetMultiBuyDiscountNames() %>

GetGtmProductJson

• object additionalData
• string purpose

Returns a JSON string containing the data of the transformed product (SKU), in a format suitable for use with the Google Tag Manager and Universal Analytics Enhanced Ecommerce features.

For more information, see Integrating Google Analytics Enhanced Ecommerce.

The optional additionalData parameter allows you to extend the returned JSON string (custom fields and values).

The optional purpose parameter can be processed in code customizations of the product data creation process, if you need to return different JSON data for various scenarios.

<%# GetGtmProductJson(“{ ‘list’ : ‘Search Results’}”, “searchImpressions”) %>

GetAge

• object dateOfBirth
• string unknownAge

Returns age calculated according to the date of birth given in the first parameter. If the date of birth is not available, the method returns the string specified in the second parameter.

<%# GetAge(Eval(“UserDateOfBirth”),“Unknown age”) %>

GetBadgeImage

• int badgeId

Returns an image tag that displays the specified user badge.

<%# GetBadgeImage(Eval<int>(“UserBadgeID”)) %>

GetBadgeName

• int badgeId

Returns the display name of the specified badge.

<%# GetBadgeName(Eval<int>(“UserBadgeID”)) %>

GetGender

• object genderObj

Returns the gender of users according to the value specified in the parameter. Load the value from the user’s gender field.

• 1 = Male
• 2 = Female
• unspecified (0) = N/A

<%# GetGender(Eval(“UserGender”)) %>

GetGroupAvatarImage

• object avatarId
• int maxSideSize
• int width
• int heigth
• object alt

Returns an image tag that displays the avatar of a group. The group is either identified automatically using the AvatarGuid field of the transformed group, or you can optionally specify an identifier value using the first parameter.

<%# GetGroupAvatarImage(200, “Alternate text”) %>
<%# GetGroupAvatarImage(Eval(“GroupAvatarID”), 200, “Alternate text”) %>
<%# GetGroupAvatarImage(Eval(“GroupAvatarID”), 200, 150, 150, “Alternate text”) %>

GetGroupProfileUrl

• object groupNameOjb
• string siteName

Returns the URL of the specified group’s profile page.

<%# GetGroupProfileUrl(Eval(“GroupName”) %>

GetMemberProfileUrl

• object memberNameObj
• string siteName

Returns the URL of the user profile page for the specified group member.

<%# GetMemberProfileUrl(Eval(“UserName”)) %>

GetUserAvatarImage

• object avatarId
• object userId
• int maxSideSize
• int width
• int heigth
• object alt

Returns an image tag that displays the avatar of a user. The user is either identified automatically using the AvatarGuid field of the transformed user, or you can specify either an avatar identifier or user identifier.

<%# GetUserAvatarImage(200, “Alternate text”) %>
<%# GetUserAvatarImage(Eval(“UserID”), 200, 150, 150, “Alternate text”) %>
<%# GetUserAvatarImage(Eval(“UserAvatarID”), Eval(“UserID”), 200, “Alternate text”) %>
<%# GetUserAvatarImage(Eval(“UserAvatarID”), Eval(“UserID”), 200, 150, 150, “Alt”) %>

GetUserAvatarImageUrl

• object avatarId
• object userId
• string userEmail
• int maxSideSize
• int width
• int heigth

Returns the URL of the specified user’s avatar image. If the user does not have an avatar, the method returns the URL of the default avatar image.

<%# GetUserAvatarImageUrl(Eval(“UserAvatarID”), Eval(“UserID”), 200, 150, 150) %>

GetUserFullName

• int userId

Returns the full name of the specified user.

<%# GetUserFullName(Eval<int>(“UserID”)) %>

GetUserProfileUrl

• object userNameObj
• string siteName

Returns the URL of the user profile page for the specified user.

<%# GetUserProfileURL(Eval(“UserName”)) %>

TrimSitePrefix

• object userName

Removes the site prefix from user names (if site prefixes are enabled in Settings -> Security & Membership -> Use site prefix for user names).

FormatDate

• object dateTime

Displays the specified date without the time component. The method automatically formats the date according to the current culture.

<%# FormatDate(DateTime.Now) %>

FormatDateTime

• object dateTime
• string format

Displays the date and time value according to a format string. The method formats the date and time according to the current culture.

<%# FormatDateTime(DateTime.Now, “MM/dd/yyyy HH:mm”) %>

GetDate

• string dateTimeField

Loads a date value from the specified field of the transformed object’s data.

<%# GetDate(“NewsReleaseDate”) %>

GetDateTime

• string dateTimeField
  OR
• object dateTime
  OR
• DateTime dateTime
• string format

Loads a date and time value from the specified field of the transformed object’s data. The value uses the time zone set for the server.

Optionally, you can format the date and time value according to a format string.

<%# GetDateTime(“NewsReleaseDate”) %>

GetCustomDateTime

• object dateTime
• string timeZoneName

Converts a date and time value to the specified time zone.

<%# GetCustomDateTime(DateTime.Now, “GreenwichMeanTime”) %>

GetDateTimeString

• object dateTime
• bool showTooltip

Converts the specified date and time value to the time zone set for the server. The second parameter determines whether the displayed date and time has a tooltip.

<%# GetDateTimeString(“NewsReleaseDate”, true) %>

GetSiteDateTime

• object dateTime

Converts the specified date and time value to the current site’s time zone.

<%# GetSiteDateTime(Eval(“NewsReleaseDate”)) %>

GetUserDateTime

• object dateTime

Converts the specified date and time value to the time zone set for the user viewing the page.

<%# GetUserDateTime(Eval(“NewsReleaseDate”)) %>

SearchResultUrl

• bool absolute
• bool addLangParameter

Returns the URL of the page containing the details of the search result.

• The optional ‘absolute’ parameter indicates if the returned URL is absolute.
  • False by default.
• The optional ‘addLangParameter’ indicates if a culture specific query should be added to the URL.
  • True by default. Note that clicking a link leading to a different culture changes the visitor’s site culture.

<%# SearchResultUrl(true, false) %>

Note: The SearchResultUrl method does not return valid URLs for search results produced by general indexes, since the indexed objects are not pages and there is no default page to display the object details. You need to write and use a custom transformation method to generate the correct URL of a custom page displaying the appropriate information.

Combine with default culture 

When the Combine with default culture setting is enabled, visitors will see pages in the default culture if they aren’t translated to their current culture.

• If the addLangParameter is set to false, the site culture will NOT change once visitors click the link leading to the page in the default culture. That is, they keep on browsing the site in the culture they made the search in.
• If the addLangParameter is set to true, the site culture will change once visitors click the link leading to the page in the default culture. That is, they keep on browsing the site in the default culture afterwards.

SearchHighlight

• string text
• string startTag
• string endTag

Wraps the text of the first parameter into the tags specified by the other two parameters.

<%# SearchHighlight(SearchResultUrl(),“<strong>”,“</strong>”)%>

GetSearchImageUrl

• string noImageUrl
• int maxSideSize

Returns the URL of the current search result’s image.

The first parameter specifies the URL used if no image is found – enter either the full relative path starting from the application root (~/), or a partial path starting from the ~/App_Themes/<skin_folder>/Images/ directory. The second parameter specifies the maximum side size to which the method resizes the image.

<%# GetSearchImageUrl(“~/App_Themes/Default/Images/CMSModules/CMS_SmartSearch/no_image.gif”, 90) %>

<%# GetSearchImageUrl(“/CMSModules/CMS_SmartSearch/no_image.gif”, 90) %>

GetSearchValue

• string columnName

Returns the value of the specified field for the current search result. Allows you to access both the general fields of the given objects type (page, custom table etc.) and any other fields included in the search index.

<%# GetSearchValue(“DocumentName”) %>

GetSearchedContent

• string content

Parses the searched content as XML if required, and removes dynamic controls and macro expressions.

GetAtomDateTime

• object dateTime

Returns the specified date and time value in a format suitable for Atom feeds (according to RFC 3339).

<%# GetAtomDateTime(Eval(“DocumentCreatedWhen”)) %>

GetRSSDateTime

• object dateTime

Returns the specified date and time value in a format suitable for RSS feeds (according to RFC 882).

<%# GetRSSDateTime(Eval(“DocumentCreatedWhen”)) %>

GetBlogCommentUrlForFeed

• object documentIdObj

Returns the URL of the comments added to the blog post specified by a page identifier. Includes the feed query string parameter in the URL.

<%# GetBlogCommentUrlForFeed(Eval(“DocumentID”)) %>

GetDocumentUrlForFeed

-

Returns the URL of the transformed document with the feed query string parameter in the URL. The method takes the feed name from the Feed name property of the syndication web part used to generate the feed.

Note: Since the method adds the feed query string parameter, please use a different parameter name in the Feed querystring key property of the syndication web part.

<%# GetDocumentUrlForFeed() %>

GetForumPostUrlForFeed

• object postIDPath
• object forumId

Returns the URL of the forum post specified by the path in the first parameter and the forum identifier in the second parameter. Includes the feed query string parameter in the URL.

<%# GetForumPostUrlForFeed(Eval(“PostIDPath”), Eval(“PostForumID”)) %>

GetMediaFileUrlForFeed

• object fileGUID
• object fileName

Returns the URL of the media file specified by the GUID in the first parameter and the file name in the second parameter. Includes the feed query string parameter in the URL.

<%# GetMediaFileUrlForFeed(Eval(“FileGUID”), Eval(“FileName”)) %>

GetMessageBoardUrlForFeed

• object documentIdObj

Returns the URL of the message board specified by the identifier of the page containing the message board. Includes the feed query string parameter in the URL.

<%# GetMessageBoardUrlForFeed(“DocumentIdObj”) %>

GetSharePointFileUrl

• string fileRefColumnName
• int cacheMinutes
• int cacheFileSize
• int width
• int height
• int maxSideSize

Returns the URL of a file from a SharePoint server. The first parameter sets the name of the data column containing the name of the file (FileRef by default). Has optional parameters for specifying file caching and image dimensions.

<%# GetSharePointFileUrl(“NameOfColumnContainingPathToFile”, 5, 1024) %>

GetSharePointImageUrl

• string fileRefColumnName
• int width
• int height
• int maxSideSize

Returns the URL of an image file from a SharePoint server. The first parameter sets the name of the data column containing the name of the file (FileRef by default). Has optional parameters for specifying image dimensions.

<%# GetSharePointImageUrl(“NameOfColumnContainingPathToFile”, null, null, 300) %>