Kentico CMS 6.0 Controls

Implementing custom functionality

Implementing custom functionality

 Previous topic Next topic Mail us feedback on this topic!  

Implementing custom functionality

 Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

This tutorial follows up on the one from the Getting started topic and will demonstrate how custom functionality can be added to action buttons and columns using the handler of the OnExternalDataBound event:

 

1. Open the web form from the previous tutorial as well as its code behind and XML configuration files.

 

2. Modify the XML configuration file like in the following code:

 

<?xml version="1.0" encoding="utf-8" ?>

<grid>

 <actions>

   <action name="edit" caption="$General.Edit$" icon="Edit.png" externalsourcename="edit_modify" />

 </actions>

 

 <columns>

   <column source="UserName" caption="$general.username$" width="100%" externalsourcename="user_modify" />

 </columns>

 

 <query name="cms.user.selectall" columns="UserID, UserName" />

 

</grid>

 

This defines the externalsourcename attributes used to identify the action or column in the OnExternalDataBound handler, where the required functionality can be implemented.

 

3. Switch to the code behind file, and add the sections marked in the following code:

 

[C#]

 

using System.Data;

using CMS.SiteProvider;

using CMS.GlobalHelper;

 

 

public partial class UniGridExample_User_UniGrid : System.Web.UI.Page

{

    protected void Page_Load(object sender, EventArgs e)

    {

 

        // Assigns a handler for the OnAction event

        UserGrid.OnAction += userGrid_OnAction;

        

        // Assigns a handler for the OnExternalDataBound event

        UserGrid.OnExternalDataBound += userGrid_OnExternalDataBound;

 

 

 

   }

 

 

   /// <summary>

  /// Handles the Unigrid's OnExternalDataBound event.

  /// </summary>

  protected object userGrid_OnExternalDataBound(object sender, string sourceName, object parameter)

   {

      switch (sourceName)

       {

          //Custom code for the edit action

          case "edit_modify":

 

              //Gets the value of the UserName column from the current data row

              string userName = ValidationHelper.GetString(((DataRowView)((GridViewRow)parameter).DataItem).Row["UserName"], "");

             

              //If the user is the administrator

              if (userName == "administrator")

               {

 

                  //Gets the ImageButton object of the edit action that is being processed

                  ImageButton button = ((ImageButton)sender);

                 

                  //Disables the button and changes its icon

                   button.ImageUrl = "~/App_Themes/Default/Images/Design/Controls/UniGrid/Actions/Editdisabled.png";

                   button.Enabled = false;

               }

 

              break;

 

          //Custom code for the UserName column

          case "user_modify":

 

              //Returns modified user names to be displayed in the UniGrid

              return Convert.ToString(parameter) + " - modified";

       }

 

      return parameter;

   }

 

       

    /// <summary>

    /// Handles the UniGrid's OnAction event.

    /// </summary>

    protected void userGrid_OnAction(string actionName, object actionArgument)

    {

        //Defines the code used to implement the edit action

        if (actionName == "edit")

        {

            //Sets an integer to the value of the actionArgument parameter (UserID)

            int userId = ValidationHelper.GetInteger(actionArgument, 0);

            

            //Gets a UserInfo object of the user with the given ID

            UserInfo ui = UserInfoProvider.GetUserInfo(userId);

            

            //If user exists

            if (ui != null)

            {

              //Sets the information label to display the full name of the edited user

                lblInfo.Visible = true;

                lblInfo.Text = "Edited user: " + HTMLHelper.HTMLEncode(ui.FullName);

            }                        

        }

    }

}

 

This code demonstrates how custom functionality can be handled for actions and columns. The parameters of OnExternalDataBound event handlers are explained below:

 

•object sender - is used to pass the ImageButton object of the current action. For columns, it contains a DataRowView of the current row.

•string sourceName - is used to identify the action or column for which the functionality is implemented. The name passed into this parameter is defined in the UniGrid's definition in the externalsourcename attribute of individual <action> or <column> elements.

•object parameter - is used to pass the value in the current row of a column. For actions, it contains a DataRowView of the current row.

 

This example modifies the edit action to be disabled for the UniGrid row containing the user named administrator, and also alters the values displayed in the UserName column. Any custom functionality required for actions or columns can be implemented in a similar fashion.

 

4. Save the changes to all files. Now right-click the web form in the Solution explorer and select View in Browser. The resulting page should display a table just like in the example before, but all the values in the User name column will be modified, and the edit action for the administrator user will be grayed out and won't be functional:

 

controls_clip0064