Adding custom UniGrid transformations

The UniGrid provides built-in transformations for easy formatting of the content of columns. To learn about the UniGrid transformations that are available by default, see the description of the externalsourcename column attribute in Reference - UniGrid definition.

If you need to display column values in a custom format, you can register your own UniGrid transformations:

Open your Kentico project in Visual Studio.
Create a custom module class.
- Either add the class into a custom project within the Kentico solution (recommended) or directly into the Kentico web project (into a custom folder under the CMSApp project for web application installations, into the App_Code folder for web site installations).
Override the module's OnInit method and and register your UniGrid transformations.
- Call the UniGridTransformations.Global.RegisterTransformation method for each transformation.
Implement the methods that define the functionality of your custom UniGrid transformations.

For basic execution of initialization code, you only need to register a "code-only" module through the API. You do NOT need to create a new module within the Modules application in the Kentico administration interface.

C#Example

using CMS; using CMS.Base; using CMS.DataEngine; using CMS.UIControls; using CMS.Helpers; using CMS.PortalEngine; // Registers the custom module into the system [assembly: RegisterModule(typeof(CustomUniGridTransformationModule))] public class CustomUniGridTransformationModule : Module { // Module class constructor, the system registers the module under the name "CustomUniGridTransformations" public CustomUniGridTransformationModule() : base("CustomUniGridTransformations") { } // Contains initialization code that is executed when the application starts protected override void OnInit() { base.OnInit(); // Registers the #customBoldText UniGrid transformation UniGridTransformations.Global.RegisterTransformation("#customBoldText", CustomBoldText); // Registers the #isStyleSheetCheckedOut UniGrid transformation UniGridTransformations.Global.RegisterTransformation("#isStyleSheetCheckedOut", IsStyleSheetCheckedOut); } // Method that defines the #customBoldText UniGrid transformation // Wraps the UniGrid column text value into a element private static object CustomBoldText(object parameter) { return "" + ValidationHelper.GetString(parameter, "") + ""; } // Method that defines the #isCheckedOut UniGrid transformation // Indicates whether the specified stylesheet object is currently checked out for editing private static object IsStyleSheetCheckedOut(object parameter) { // Gets the stylesheet object based on the ID in the parameter CssStylesheetInfo stylesheet = CssStylesheetInfoProvider.GetCssStylesheetInfo(ValidationHelper.GetInteger(parameter, 0)); // Evaluates whether the stylesheet is checked out if ((stylesheet != null) && stylesheet.Generalized.IsCheckedOut) { return "" + ResHelper.GetString("general.yes") + ""; } return "" + ResHelper.GetString("general.no") + ""; } }

Cookie consent