Thursday, February 11, 2010

Moving data between two ListBoxes - Difference between jQuery 1.3.2 and jQuery 1.4

Recentlya new version of jQuery was released. This version is 1.4. As with anynew version, ultimately you see what used to take you several lines ofcode, now rolled up into a single line of code. I'm going todemonstrate a question I've been asked many times on forums and that ishow to move selected items from one<select> element toanother. I'll show you how you could do it using jQuery 1.3.2 and howto minimize the code by using the new 1.4 library. Before we begin, thenew version can be found here.
The HTML
TheHTML for this is pretty straight forward. It's simply two<select> elements side by side with two buttons betweenthem. Here's what it looks like:
Move data between two listboxes
<form method="get">             
      <select id="SelectLeft" multiple="multiple">
            <option value="1">Australia</option>
            <option value="2">New Zealand</option>
            <option value="3">Canada</option>
            <option value="4">USA</option>
            <option value="5">France</option>
      </select>
           
      <input id="MoveRight" type="button" value=" >> " />
      <input id="MoveLeft" type="button" value=" << " />
       
      <select id="SelectRight" multiple="multiple">          
      </select>
</form>
jQuery 1.3.2
Below is the code to move the selected items from each <select> element. 
<script language="javascript" type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>   
    <script language="javascript" type="text/javascript">
        $(function() {
            $("#MoveRight,#MoveLeft").click(function(event) {
                var id = $(event.target).attr("id");
                var selectFrom = id == "MoveRight" ? "#SelectLeft" : "#SelectRight";
                var moveTo = id == "MoveRight" ? "#SelectRight" : "#SelectLeft";
                var selectedItems = $(selectFrom + " :selected");
                var output = [];               
                $.each(selectedItems, function(key, e) {                   
                  output.push('<option value="' + e.value + '">' + e.text + '</option>');
                                });
               
                $(moveTo).append(output.join(""));               
                selectedItems.remove();
            });
        });
    </script>
I'vebound one event handler for the button clicks. To decide whichdirection the selected items should go, I'm using the ID of the buttonthat fired the event:
var id = $(event.target).attr("id");
var selectFrom = id == "MoveRight" ? "#SelectLeft" : "#SelectRight";
var moveTo = id == "MoveRight" ? "#SelectRight" : "#SelectLeft";
Next I create an empty array and loop through every selected item and add it to the end of the array:
var output = [];               
$.each(selectedItems, function(key, e) {                   
      output.push('<option value="' + e.value + '">' + e.text + '</option>');
});
Then I append it to the end of the <select> element and remove the moved items:
$(moveTo).append(output.join(""));               
selectedItems.remove();
Overall I think that's a good approach. In jQuery 1.4 we can make this better!
jQuery 1.4
In the new jQuery library, the team has introduced a new function called toArray. This retrieves all the DOM elements contained in the jQuery set, as an array. So here's the code below:
<script language="javascript" type="text/javascript" src="http://code.jquery.com/jquery-1.4.1.min.js"></script>
    <script language="javascript" type="text/javascript">
        $(function() {
            $("#MoveRight,#MoveLeft").click(function(event) {
                var id = $(event.target).attr("id");
                var selectFrom = id == "MoveRight" ? "#SelectLeft" : "#SelectRight";
                var moveTo = id == "MoveRight" ? "#SelectRight" : "#SelectLeft";
                var selectedItems = $(selectFrom + " :selected").toArray();
                $(moveTo).append(selectedItems);
                selectedItems.remove;
            });
        });
    </script> 
The first thing you'll notice is the code has been reduced. Thanks to the toArray function, I have eliminated the need to loop through the selected items. Now they're returned as an array:
var selectedItems = $(selectFrom + " :selected").toArray();
And to add them to the <select> element, I no longer need to use the join function, I simply append them:
$(moveTo).append(selectedItems);
 Nice and simple! The entire source code of this article can be downloaded over here

AutoScroll an ASP.NET Multiline TextBox using jQuery

Thisarticle demonstrates how to autoscroll a multiline textbox both upwardsand downwards using jQuery 1.3.2. This article is a sample chapter frommy EBook called 51 Tips, Tricks and Recipes with jQumry and ASP.NET Controls. The chapter has been modified a little to publish it as an article.


Notethat for demonstration purposes, I have included jQuery code in thesame page. Ideally, these resources should be created in separatefolders for maintainability. The code shown below has been tested onIE7, Firefox 3, Chrome 2 and Safari 4


Let us quickly jump to the solution and see how to AutoScroll a multiline textbox
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>AutoScroll a Multiline TextBox</title>
    <script type="text/javascript"
     src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js">
    </script>


    <script type="text/javascript">
        $(function() {
            var $tb = $('textarea[id$=tb1]');
            $('input[id$=btnScroll]').toggle(
            function(e) {
                e.preventDefault();
                scrollArea($tb, $tb[0].scrollHeight);
            },


            function(e) {
                e.preventDefault();
                scrollArea($tb, 0);
            });
        });


        function scrollArea(ctrl, ht) {
            ctrl.animate({ scrollTop: ht }, 1000);
        }
    </script>
</head>
<body>
    <form id="form1" runat="server">
    <div class="smallDiv">
        <h2>Scroll the box contents by clicking on the Button</h2>
        <br /><br />
        <asp:TextBox ID="tb1" runat="server" TextMode="MultiLine"
        Text="Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem
        Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum
        Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum
        Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum
        Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum"
        Rows="5"/>
        <br />
        <asp:Button ID="btnScroll" runat="server" Text="Scroll"/>
        <br /><br />
        Tip: The Text can be scrolled both downwards and upwards.
    </div>
    </form>
</body>
</html>
Whenthe user clicks on the button (btnScroll), we toggle the clickbehavior. On the first click, we cancel the postback by using e.preventDefault() and then call a function called scrollArea() passing in the textarea and the scrollHeight. The code $tb[0].scrollHeight is for scrolling downwards
e.preventDefault();
scrollArea($tb, $tb[0].scrollHeight);
Whenthe user clicks the button (btnScroll) again, the postback is cancelledand the scrollHeight is set to 0 (zero). This is done for scrollingupwards.
e.preventDefault();
scrollArea($tb, 0);
ThescrollArea() function accepts the textarea that is to be scrolled aswell as the scrollHeight. We then animate the scrollTop property toscroll upwards/downwards depending on the height parameter. Theduration of the animation is set to 1000 milliseconds which provides asmooth scrolling effect
function scrollArea(ctrl, ht) {
    ctrl.animate({ scrollTop: ht }, 1000);
}
The code here assumes that you are not scrolling the textarea manually and then clicking the Scroll button.
You can see a Live Demo over here.


I hope you found this article useful and I thank you for viewing it. This article was taken from my EBook called 51 Tips, Tricks and Recipes with jQuery and ASP.NET Controls which contains similar recipes that you can use in your applications.

Call Server Side function from Client Side Code using PageMethods in ASP.NET AJAX

You cannot call server-side code ‘directly’ from client-side code. That isbecause by design, the server side code executes at server side andclient side code at the client. However there are some workarounds. Tocall serverside code from javascript, you will need to use AJAX, andthe easiest way out, is to use the ASP.NET AJAX Extensions.
Oneoption while using Microsoft ASP.NET AJAX is to call ASP.NET Webservices (.asmx files) from the browser by using client script. Thescript can call a webservice containing server-based methods (Webmethods) and invoke these methods without a postback and withoutrefreshing the whole page. However this approach could be overkillsometimes, to perform the simplest of tasks. Moreover the logic needsto be kept in a separate .asmx file. We need something that is more‘integrated’ with our solution.
Theoption we are going to use in this article involves PageMethods. APageMethod is basically a public static method that is exposed in thecode-behind of an aspx page and is callable from the client script.PageMethods are annotated with the [WebMethod] attribute. The pagemethods are rendered as inline JavaScript.
Letus explore PageMethods with an example. The example we will bediscussing here may not be the best example to explain PageMethods, butit will give you an idea of how to call server side code from clientside. In this example, we will be connecting to the Customers table inthe Northwind database. We will have some textboxes which will acceptthe CustomerID and in turn return the Contact Name of that Customer.The method returning ContactName will be called whenever the textboxloses focus. We will be using the onblur event where a javascript codewill take in the value(CustomerID) from the textbox. This javascriptfunction will then call a PageMethod (server side code) which returnsthe ContactName without any page refresh.
Iassume that you have downloaded and installed ASP.NET AJAX extensionsfor ASP.NET 2.0. If not, I would advise you to download the extensionsfrom hereand install it before moving ahead. At any point of time, if you find adifficulty in understanding the code, download the sample projectattached with this article at the end.
Step 1:Create an ASP.NET AJAX enabled website. Go to File > New >Website > ASP.NET AJAX-Enabled Web Site. Give the solution a nameand location and click Ok.
Step 2:Drag and drop 2 labels and 4 textbox controls. We will be accepting theCustomerID from the user in the 2 textboxes and displaying the‘ContactName’ in the other two textboxes. The textboxes that willdisplay ‘ContactName’ has some properties set that will make it appearas a label without a border. Just set the BorderStyle=None,BorderColor=Transparent and ReadOnly=True. The markup will look similarto the following:
<form id="form1" runat="server">    
        <asp:ScriptManager ID="ScriptManager1" runat="server"/>
        <div>
        <asp:Label ID="lblCustId1" runat="server" Text="Customer ID 1"></asp:Label>
        <asp:TextBox ID="txtId1" runat="server"></asp:TextBox><br />
            <asp:TextBox ID="txtContact1" runat="server" BorderColor="Transparent" BorderStyle="None"
                ReadOnly="True"></asp:TextBox><br />
        <br />
        <asp:Label ID="lblCustId2" runat="server" Text="Customer ID 2"></asp:Label>
        &nbsp;
        <asp:TextBox ID="txtId2" runat="server"></asp:TextBox><br />
            <asp:TextBox ID="txtContact2" runat="server" BorderColor="Transparent" BorderStyle="None"
                ReadOnly="True"></asp:TextBox>&nbsp;<br />
            </div>
    </form>
Before moving ahead, we will store our connection string information in the Web.config. Add the following tag below your </configSections> tag. Remember we have created an ‘ASP.NET AJAX enabled website’. The tag </configSections> along with some other tags automatically get added to the web.config.
<connectionStrings>
            <removename="all"/>
            <addname="NorthwindConnectionString"connectionString="Data Source=(local); Initial Catalog=Northwind; Integrated Security = SSPI;"/>
      </connectionStrings>
Step 3:Currently we will add a method, ‘GetContactName()’ which will accept aCustomerID and return the Contact Name information from the Northwinddatabase, Customer table. We will then transform this method as aPageMethod.
C#
public static string GetContactName(string custid)
    {
        if (custid == null || custid.Length == 0)
            return String.Empty;
        SqlConnection conn = null;
        try
        {
            string connection = ConfigurationManager.ConnectionStrings["NorthwindConnectionString"].ConnectionString;
            conn = new SqlConnection(connection);
            string sql = "Select ContactName from Customers where CustomerId = @CustID";
            SqlCommand cmd = new SqlCommand(sql, conn);
            cmd.Parameters.AddWithValue("CustID", custid);
            conn.Open();
            string contNm = Convert.ToString(cmd.ExecuteScalar());
            return contNm;
        }
        catch (SqlException ex)
        {
            return "error";
        }
        finally
        {
            conn.Close();
        }
    }
VB.NET
 Public Shared Function GetContactName(ByVal custid As String) As String
        If custid Is Nothing OrElse custid.Length = 0 Then
            Return String.Empty
        End If
        Dim conn As SqlConnection = Nothing
        Try
            Dim connection As String = ConfigurationManager.ConnectionStrings("NorthwindConnectionString").ConnectionString
            conn = New SqlConnection(connection)
            Dim sql As String = "Select ContactName from Customers where CustomerId = @CustID"
            Dim cmd As SqlCommand = New SqlCommand(sql, conn)
            cmd.Parameters.AddWithValue("CustID", custid)
            conn.Open()
            Dim contNm As String = Convert.ToString(cmd.ExecuteScalar())
            Return contNm
        Catch ex As SqlException
            Return "error"
        Finally
            conn.Close()
        End Try
    End Function
Step 4:We will now transform this method as a PageMethod and then call thismethod GetContactName() from client side code; i.e. using JavaScript.To enable the method as a PageMethod, add the attribute [WebMethod] ontop of the method:
C#
[System.Web.Services.WebMethod]
public static string GetContactName(string custid)
{
}
VB.NET
<System.Web.Services.WebMethod()> _
    Public Shared Function GetContactName(ByVal custid As String) As String
   End Function
At the sametime, add the attribute EnablePageMethods="true" to the ScriptManager as shown below:
<asp:ScriptManager ID="ScriptManager1" runat="server" EnablePageMethods="true"/>
Step 5:Let us now create the JavaScript that will call this server side code.Add a javascript file called script.js to your solution (Right ClickProject > Add New Item > Jscript File > Rename file toscript.js). Add the following code to the javascript file.
function CallMe(src,dest)
 {    
     var ctrl = document.getElementById(src);
     // call server side method
     PageMethods.GetContactName(ctrl.value, CallSuccess, CallFailed, dest);
 }
 // set the destination textbox value with the ContactName
 function CallSuccess(res, destCtrl)
 {    
     var dest = document.getElementById(destCtrl);
     dest.value = res;
 }
 // alert message on some failure
 function CallFailed(res, destCtrl)
 {
     alert(res.get_message());
 }
Step 6:We now need to reference this JavaScript file from our aspx page andinvoke the ‘CallMe()’ method whenever the textbox loses focus. To do so:
Add a reference to the javascript file in the body tag as shown below:
<body>
<script type="text/javascript" language="javascript" src="script.js"> </script>
    <form id="form1" runat="server">    
………
Step 7: To invoke the methods whenever the textbox looses focus, add these lines of code in the Page_Load() event
C#
if (!Page.IsPostBack)
        {
            txtId1.Attributes.Add("onblur", "javascript:CallMe('" + txtId1.ClientID + "', '" + txtContact1.ClientID + "')");
            txtId2.Attributes.Add("onblur", "javascript:CallMe('" + txtId2.ClientID + "', '" + txtContact2.ClientID + "')");
        }
VB.NET
If (Not Page.IsPostBack) Then
                 txtId1.Attributes.Add("onblur", "javascript:CallMe('" &txtId1.ClientID & "', '" & txtContact1.ClientID & "')")
                 txtId2.Attributes.Add("onblur", "javascript:CallMe('" &txtId2.ClientID & "', '" & txtContact2.ClientID & "')")
End If
Asshown above, we are using the Attributes.Add that lets us add anattribute to the server control’s System.Web.UI.AttributeCollectionobject. The function ‘CallMe’ kept in the ‘script.js’ file will beinvoked. We are passing the source and destination textboxes asparameters. The source textbox will contain the CustomerID. TheCustomerID will be looked up in the Customers table and thecorresponding ‘ContactName’ will be retrieved in the destinationtextbox.
Wellthat is all that is needed to invoke server side code from client side.Run the code. Type ‘ALFKI’ in the first textbox and hit the tab key.You will see that the javascript function goes ahead and calls thePageMethod GetContactName() using PageMethods.GetContactName. Itpasses the value of the source textbox which contains the CustomerID.The ‘ContactName’ returned is displayed in the second textbox below thefirst one, in our case the value displayed is ‘Maria Anders’.

Hide/Show validator callout control using javascript

This blog we will see how to show and hide a ASP.NET AJAX’ (AJAXControlToolkit) ValidatorCalloutExtender control using javascript. Below is an aspx page with a validator callout control.


<body>
    <form id="form1" runat="server">
    <div>
        <!--ASP.NET Drop down control-->
        <asp:DropDownList ID="status" runat="server" >
            <asp:ListItem Selected="True" Text="Select" Value="0" />
            <asp:ListItem Text="One" />
            <asp:ListItem Text="Two" />
            <asp:ListItem Text="Three" />
        </asp:DropDownList>

        <!--ASP.NET Required Field Validator to validate the drop down.-->
       <asp:RequiredFieldValidator ID="statusValidator" runat="server"ErrorMessage="Please choose a value other than 'Select'"
            ControlToValidate="status" InitialValue="0" Visible="true">
        </asp:RequiredFieldValidator>
    <!--Validator callout control-->
        <AJAXControls:ValidatorCalloutExtender ID="statusValidator_ValidatorCalloutExtender"
            runat="server" TargetControlID="statusValidator">
        </AJAXControls:ValidatorCalloutExtender>
        <asp:Button ID="submit" Text="Submit" OnClientClick="javascript:return ValidatePage();"
            runat="server" />
    </div>
    <asp:ScriptManager ID="ScriptManager1" runat="server">
    </asp:ScriptManager>
    </form>
</body>


The above code has a dropdown control with an ASP.NET required field validator control and a validator callout control attached to it. As soon as you click the submit button and if there is a validation error the error will be popped out in the validator callout control as shown below.

 Popping of the error message in a validator callout control happens automatically. But there may be scenario where you would like to hide or show the validator control using javascript. The below sample code does exactly that.


<script language="javascript" type="text/javascript">
function ValidatePage()
{        
    //Function which calls the whole validation for the page.
    if (Page_ClientValidate())       
    {
        return true;
    }
    else
    {       
        hideValidatorCallout();
        return false;
    }
}

//User defined method which hides the AjaxControlToolkit ValidatorCalloutExtender control
function hideValidatorCallout()
{

    //Below code hides the active AjaxControlToolkit ValidatorCalloutExtender control.
AjaxControlToolkit.ValidatorCalloutBehavior._currentCallout.hide();
    setTimeout(showValidatorCallout, 3000);   
}

function showValidatorCallout()
{
    //Gets the AjaxControlToolkit ValidatorCalloutExtender control using the $find method.
   AjaxControlToolkit.ValidatorCalloutBehavior._currentCallout =$find('<% =statusValidator_ValidatorCalloutExtender.ClientID%>');

    //Below code unhides the AjaxControlToolkit ValidatorCalloutExtender control.
AjaxControlToolkit.ValidatorCalloutBehavior._currentCallout.show(true);
}
</script>