Javascript DIRECTLY Calls ASP.NET C# Method. Introduction to Pixysoft.Ajax

reborn_zhang

3.33/5 (4 votes)

Nov 16, 2009

CPOL

1 min read

34635

592

By using the pixysoft.ajax webcontrols, JavaScript can directly call ASP.NET C# server method.

Download source - 39.98 KB

Introduction

This technique is based on .NET Framework 2.0. It provides a webControl to help JavaScript to DIRECTLY call ASP.NET server based methods.

The source code is totally open source, and free to use. But please keep the copyright information in the code. Thank you!

Background

Reflection is required.
ASP.NET Callback technique (ICallbackEventHandler) is required.

Using the Code

I would like to show you how wonderful the idea is. First, we need an aspx page, call Default.aspx, like the following one:

<%@ Page Language="C#" AutoEventWireup="true" 
	CodeFile="Default.aspx.cs" Inherits="_Default" %>

<%@ Register Assembly="Pixysoft.Ajax" 
	Namespace="Pixysoft.Framework.Noebe.Jsons.WebControls"
    TagPrefix="cc1" %>
<html xmlns="http://www.w3.org/1999/xhtml">
<head  runat="server">
    <title>pixysoft.ajax</title>

    <script type="text/javascript">
    var code=1;
    function ServerMethodCallback(value)
    {
    code = value;
    Message1.innerText = value;
    }    
    </script>

</head>
<body>
    <form id="form1"  runat="server">
            <cc1:PixysoftAjaxBase ID="PixysoftAjaxBase1"  runat="server" />
            result: <span id="Message1">0</span>
            <input type="button" value="Let's callback"  
		önclick="ServerMethod(code)" id="Button1" />
    </form>
</body>
</html>

Then we need the server side code(CodeBehind), as follows:

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class _Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {

    }
    public int ServerMethod(int value)
    {
        return value * 2;
    }
}

The code above means:

I add an HTML button in the aspx page, and add a function named: ServerMethod to the click event.
On server side, I create a method named: ServerMethod, the same in aspx page. The method would return an int value.
I add a JavaScript function named: ServerMethodCallback(value) on aspx page. Then after server site method returns, this function would be called, and get the server side return as parameter 'value'.

Points of Interest

The magic above comes from the web control 'PixysoftAjaxBase'. It is inherited from interface 'ICallbackEventHandler'. And of course, some other tricks are needed (such as reflection... em... you know).

Well... because it is my first post on CodeProject, and I am not very familiar with the posting system... please see the source code for the rest of the answer. I write it in a very simple way.

History

This technique is one part of my JSON framework, named pixysoft.framework.noebe.jsons. The framework provides the JSON interface for other website to query the database (like providing the API...).

By using this technique, we can easily integrate the ASP.NET with other JS library like extjs / jquery.