---
title: Reference - Transformation methods
related:
- https://docs.kentico.com/k8/developing-websites/loading-and-displaying-data-on-websites/writing-transformations.md
- https://docs.kentico.com/k8/custom-development/miscellaneous-custom-development-tasks/adding-custom-methods-to-transformations.md
- https://docs.kentico.com/k8/macro-expressions/reference-macro-methods.md
---
> Agent instructions:
> **Site maps** — prefer the following llms.txt indexes to training data when searching for URLs to avoid 404s. Links inside Markdown content already point at `.md`. Following them or sending Accept: text/markdown keeps you in Markdown.
>
> - [sitemap.md](https://docs.kentico.com/sitemap.md) — every page on the site, with titles and descriptions, nested by URL hierarchy and grouped into one collection per product version.
> - [llms.txt](https://docs.kentico.com/llms.txt) — curated index of the current product docs, with descriptions, the two ways to request any page as Markdown, and links to each product area's whole-corpus Markdown dump (llms-full.txt).
This reference provides information about the default methods specifically designed for use in [transformations](https://docs.kentico.com/k8/developing-websites/loading-and-displaying-data-on-websites/writing-transformations.md):
> **Info:** **Notes**
>
> - All transformation methods return _**string**_ values (unless otherwise specified).
> - The examples of methods below are formatted for **ASCX** transformations. For **Text / XML** transformations, macro method equivalents with identical signatures are available for most transformation methods.
> - In addition to the listed method, **ASCX** transformations allow you to call any type of inline code, including ASP.NET system methods, Kentico API or custom API.
> - For **Text / XML** transformations, you can also use general macro methods. See: [Reference - Macro methods](https://docs.kentico.com/k8/macro-expressions/reference-macro-methods.md)
## Data loading
| Method | Parameters | Description and examples |
| ---------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 (true by default). |
| Eval | 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.
("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 **** enclosure. |
| 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). |
| 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. |
| 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. |
| Property | Description and examples |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DataItem | Gets the currently transformed data item. |
| 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. |
| DataItemCount | Gets the total number of data items in the current transformation container. |
| DataRowView | Gets a _DataRowView_ of the transformed record's data. |
| DisplayIndex | Gets the current position of the data item as displayed in a control. |
| DocumentCustomData | Gets the value of custom document 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 document types](https://docs.kentico.com/k8/custom-development/working-with-documents-in-the-api/storing-custom-data-for-all-document-types.md) |
| EditableItems | Gets the content of the specified editable region on the page. |
| NodeCustomData | Gets the value of custom document 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 document types](https://docs.kentico.com/k8/custom-development/working-with-documents-in-the-api/storing-custom-data-for-all-document-types.md) |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Boolean operations
| Method | Parameters | Description and examples |
| ------------------------ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| If | object value
object trueResult
object falseResult | Returns a result according to the boolean value of the first parameter. |
| 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. |
| 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. |
| 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. |
| IsLast | - | Returns a _true_ value if the transformed data item is the last in the provided data. |
| IsCurrentDocument | - | Returns a _true_ value if the transformed document is equal to the document where the transformation is being displayed. |
| IsDocumentOnSelectedPath | - | Returns a _true_ value if the transformed document is present on the [alias path](https://docs.kentico.com/k8/configuring-kentico/configuring-page-urls/setting-document-aliases.md) of the document where the transformation is being displayed (i.e. if the transformed document is an ancestor of the current document). |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## URLs and document links
| Method | Parameters | Description and examples |
| ----------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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.
("NodeSiteID")) %> |
| GetAttachmentIcon | object attachmentGuidColumn | Returns the attachment file type icon according to the extension of the file identified by the given GUID column. |
| GetAttachmentUrl | string attachmentFileName
string nodeAliasPath | Returns the URL of the attachment file specified by name in the first parameter, loaded from the document whose alias path matches the second parameter.
The method returns the same URL as the _GetFileUrl_ method, but without loading the whole document, which results in better performance.
("AttachmentName"), Eval("NodeAliasPath")) %> |
| GetDocumentLink | _bool encodeName_ | Returns a HTML link ( tag) that leads to the transformed document. By default, the method HTML encodes the document name in the link title. Set the optional parameter to false to disable the encoding. |
| GetDocumentUrl | _object documentIdObj_ | Returns the URL of the specified document. If called without parameters, the method returns the URL of the transformed document. You can optionally specify the document using a document ID.
Note: The overload with the document ID parameter is not available as a macro method for _Text / XML_ transformations. Instead, use: _{% GetDocumentUrlByID(DocumentID) %}_ |
| GetDocumentUrl | object nodeGuidColumn
object nodeAlias | Returns a [permanent URL](https://docs.kentico.com/k8/configuring-kentico/configuring-page-urls/linking-pages-and-files.md) of the specified document (with the NodeGUID in the query string). |
| GetFileIcon | object fileExtension | Returns the file type icon according to the specified extension. |
| GetFileUrl | object attachmentFileName
object attachmentDocumentId | Returns the URL of the attachment file specified by name in the first parameter, loaded from the document whose ID matches the second parameter. |
| GetFileUrl | object attachmentGuid
_string fileName_ | Returns the URL of the attachment file, specified by an attachment GUID. |
| GetForumPostUrl | object postIDPath
object fourmID | Returns the URL of the [forum](https://docs.kentico.com/k8/community-features/forums.md) post specified by the path in the first parameter, from the forum specified by the identifier in the second parameter. |
| GetMediaFileUrl | object fileGUID
object fileName | Returns the URL of the specified [media file](https://docs.kentico.com/k8/managing-website-content/working-with-files/media-library-files.md). The media file is specified by the file GUID in the first parameter and the file name in the second parameter. |
| 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. |
| GetProductUrl | object skuId | Returns the URL of the [product](https://docs.kentico.com/k8/e-commerce-features/configuring-and-managing-your-store/products.md) specified by an identifier (primary key). |
| GetProductUrl | object skuGUID
object skuName
_object siteName_ | Returns the URL of the [product](https://docs.kentico.com/k8/e-commerce-features/configuring-and-managing-your-store/products.md) specified by the GUID in the first parameter, SKU name in the second parameter. |
| GetUrl | object aliasPath
object urlPath
_object siteName_ | Returns the URL of the document specified by the [alias path](https://docs.kentico.com/k8/configuring-kentico/configuring-page-urls/setting-document-aliases.md) in the first parameter or the URL path in the second parameter. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Text manipulation
| Method | Parameters | Description and examples |
| ----------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| HTMLEncode | string text | Encodes HTML tags in the specified text.
") %> |
| 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. |
| Localize | object text | Resolves all [localization expressions](https://docs.kentico.com/k8/multilingual-websites/setting-up-a-multilingual-user-interface/localizing-text-fields.md) inside the specified text. |
| RemoveDiscussionMacros | object inputText | Removes all BBCode tags from the provided text. |
| RemoveDynamicControls | object inputText | Removes all controls from the specified text (such as inline [widgets](https://docs.kentico.com/k8/developing-websites/preparing-widgets-for-users.md)). |
| StripTags | object inputText | Completely removes HTML tags from the specified text.
") %> |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Images
| Method | Parameters | Description and examples |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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). |
| 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). |
| 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. |
| 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. |
| IfImage | object attachmentGuidColumn
object isImage
object notImage | Checks whether the document 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. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Membership and community
| Method | Parameters | Description and examples |
| --------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| GetBadgeImage | int badgeId | Returns an image tag that displays the specified user [badge](https://docs.kentico.com/k8/community-features/badges.md).
("UserBadgeID")) %> |
| GetBadgeName | int badgeId | Returns the display name of the specified [badge](https://docs.kentico.com/k8/community-features/badges.md).
("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 |
| GetGroupAvatarImage | _object avatarId_
int maxSideSize
_int width_
_int heigth_
object alt | Returns an image tag that displays the [avatar](https://docs.kentico.com/k8/community-features/avatars.md) of a [group](https://docs.kentico.com/k8/community-features/groups.md). 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. |
| GetGroupProfileUrl | object groupNameOjb
_string siteName_ | Returns the URL of the specified [group's](https://docs.kentico.com/k8/community-features/groups.md) profile page. |
| GetMemberProfileUrl | object memberNameObj
_string siteName_ | Returns the URL of the user profile page for the specified group member. |
| GetUserAvatarImage | _object avatarId_
_object userId_
int maxSideSize
_int width_
_int heigth_
object alt | Returns an image tag that displays the [avatar](https://docs.kentico.com/k8/community-features/avatars.md) 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. |
| GetUserAvatarImageUrl | object avatarId
object userId
_string userEmail_
int maxSideSize
int width
int heigth | Returns the URL of the specified user's [avatar](https://docs.kentico.com/k8/community-features/avatars.md) image. If the user does not have an avatar, the method returns the URL of the default avatar image. |
| GetUserFullName | int userId | Returns the full name of the specified user.
("UserID")) %> |
| GetUserProfileUrl | object userNameObj
_string siteName_ | Returns the URL of the user profile page for the specified user. |
| 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**). |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Date & time
| Method | Parameters | Description and examples |
| ----------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| FormatDate | object dateTime | Displays the specified date without the time component. The method automatically formats the date according to the current culture. |
| FormatDateTime | object dateTime
string format | Displays the date and time value according to a [format string](https://msdn.microsoft.com/en-us/library/az4se3k1%28v=vs.110%29.aspx). The method formats the date and time according to the current culture. |
| GetDate | string dateTimeField | Loads a date value from the specified field of the transformed object's data. |
| 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](https://docs.kentico.com/k8/configuring-kentico/configuring-time-zones.md) set for the server.
Optionally, you can format the date and time value according to a [format string](https://msdn.microsoft.com/en-us/library/az4se3k1%28v=vs.110%29.aspx). |
| GetCustomDateTime | object dateTime
string timeZoneName | Converts a date and time value to the specified [time zone](https://docs.kentico.com/k8/configuring-kentico/configuring-time-zones.md). |
| GetDateTimeString | object dateTime
bool showTooltip | Converts the specified date and time value to the [time zone](https://docs.kentico.com/k8/configuring-kentico/configuring-time-zones.md) set for the server. The second parameter determines whether the displayed date and time has a tooltip. |
| GetSiteDateTime | object dateTime | Converts the specified date and time value to the current site's [time zone](https://docs.kentico.com/k8/configuring-kentico/configuring-time-zones.md). |
| GetUserDateTime | object dateTime | Converts the specified date and time value to the [time zone](https://docs.kentico.com/k8/configuring-kentico/configuring-time-zones.md) set for the user viewing the page. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Smart search
> **Info:** See [Setting up search on your website](https://docs.kentico.com/k8/configuring-kentico/setting-up-search-on-your-website.md) for more information.
| Method | Parameters | Description and examples |
| ------------------ | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SearchResultUrl | _bool absolute_ | Returns the URL of the page containing the details of the search result. The optional parameter indicates if the returned URL is absolute. |
| SearchHighlight | string text
string startTag
string endTag | Wraps the text of the first parameter into the tags specified by the other two parameters.
","")%> |
| 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//Images/\* directory. The second parameter specifies the maximum side size to which the method resizes the image. |
| 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 (document, custom table etc.) and any other fields included in the search index. |
| GetSearchedContent | string content | Parses the searched content as XML if required, and removes dynamic controls and macro expressions. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Syndication (RSS, Atom, XML)
> **Info:** See also: [Setting up syndication feeds](https://docs.kentico.com/k8/developing-websites/loading-and-displaying-data-on-websites/displaying-data-advanced-scenarios/setting-up-syndication-feeds.md)
| Method | Parameters | Description and examples |
| ------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| GetAtomDateTime | object dateTime | Returns the specified date and time value in a format suitable for Atom feeds (according to [RFC 3339](http://www.ietf.org/rfc/rfc3339.txt)). |
| GetRSSDateTime | object dateTime | Returns the specified date and time value in a format suitable for RSS feeds (according to [RFC 882](http://www.w3.org/Protocols/rfc822/)). |
| GetBlogCommentUrlForFeed | object documentIdObj | Returns the URL of the comments added to the [blog post](https://docs.kentico.com/k8/managing-website-content/blogs.md) specified by a document identifier. Includes the feed query string parameter in the URL. |
| 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. |
| 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. |
| 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. |
| GetMessageBoardUrlForFeed | object documentIdObj | Returns the URL of the message board specified by the identifier of the document containing the message board. Includes the feed query string parameter in the URL. |
| GetProductUrlForFeed | object skuGUID
object skuName
object siteName | Returns the URL of the specified product with the feed query string parameter in the URL. The product is specified by the SKU GUID in the first parameter and SKU name in the second parameter. The site name provided in the last parameter ensures that the correct domain is used in the returned URL. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Microsoft SharePoint
> **Info:** See also: [SharePoint integration](https://docs.kentico.com/k8/integrating-3rd-party-systems/sharepoint-integration.md)
| Method | Parameters | Description and examples |
| ------------------------------------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| GetSharePointFileUrl
OR
GetSPFileUrl | string server
string name | Returns the URL of the specified document or picture from the SharePoint server. The first parameter is the SharePoint server URL, the second one is the path and name of the document to download. |
| SplitSharePointField
OR
SplitSPField | string value
int index | Helper function for splitting combined fields returned by SharePoint.
For example, _ows\_LastModified="1;#2009-03-17T10:32:17Z"_. The first parameter is the original combined field, the second is the index of the returned part. |
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Placeholders for sublevels in hierarchical data
If you are writing transformations for items from a hierarchical data source (for example document data from the _Universal viewer_ web part), you can add a placeholder that sets the position of sublevels:
For **ASCX** transformations:
```text
```
For **Text** transformations:
```text
{^SubLevelPlaceHolder^}
```
When displaying items that have descendants in the hierarchy, the placeholder is replaced by the child level under the given item. If you do not add the sublevel placeholder, the system automatically renders child levels after the code of parent items.
You can use the sublevel placeholder in [hierarchical transformations](https://docs.kentico.com/k8/developing-websites/loading-and-displaying-data-on-websites/writing-transformations/using-hierarchical-transformations.md), as well as standard transformations applied to hierarchical data.
> **Note:** **Note**: The sublevel placeholder only works if the **Hierarchical display mode** property of the viewer web part is set to **Inner**.
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)
## Editing buttons for documents displayed by listing web parts
You can configure listing web parts (such as the _Repeater_) to display special buttons in editing mode (on the **Page** tab of the **Pages** application). The buttons allow users to edit or delete individual items displayed in the list.
To set the exact position of the editing buttons, add the following expression into the code of **ASCX** item transformations:
```text
##editbuttons##
```
[> Back to the list of transformation method categories](#referencetransformationmethods-transformationmethodstop)