calling an ascx page method using jquery

U

8

24

I know that I can call a page method with jquery using the following syntax

$.ajax({
  type: "POST",
  url: "Default.aspx/GetDate",
  data: "{}",
  contentType: "application/json; charset=utf-8",
  dataType: "json",
  success: function(msg) {
    // Replace the div's content with the page method's return.
    $("#Result").text(msg.d);
  }
});

This works for aspx pages but is it possible with ascx pages? (web controls)

I've been trying it for about half an hour and since I can't get it to work I'm wondering if it's even possible.

Note: Just to be clear, when I try to call the ascx page I am updating the url in jquery :)

Unquestionable answered 23/2, 2009 at 19:38 Comment(0)

G

27

No, because ascx controls don't represent a real URL that can be accessed from a client machine. They're purely server-side meant to embed in other pages.

What you might want to do is just have an aspx page that provides the same snippet of html you currently have in your ascx file. An aspx page doesn't necessarily need to provide a full html document (<html><body> etc.), it can just render the user control you're interested in.

We use this technique all the time with the ingrid plugin, which requires a callback url for the table contents.

Greggrega answered 23/2, 2009 at 19:45 Comment(2)

I would add that the way you provide that snippet is by including the control on the page, rather than duplicating the code. – Ardene 23/2, 2009 at 19:48

If the control is also used server-side, I agree absolutely. However, if the purpose is purely to be used as a jQuery callback, and the control is never used inline another aspx page on the server side, then that's just unnecessary clutter. In that case, just put the code in the aspx page. – Greggrega 23/2, 2009 at 20:1

S

4

I don't think it's possible by requesting the ascx file directly--i.e. supplying "MyControl.ascx" as the url parameter to $.ajax(..). The ascx file isn't exposed directly by the web server.

You can, I believe, supply the url of the aspx page containing the user control--i.e. if an instance of MyControl.ascx lives on MyPage.aspx you would have to supply "MyPage.aspx" as the url parameter. It sounds like that might defeat the purpose for what you're trying to accomplish though.

EDIT: What Clyde said below seems like a good idea. I'm doing something similar myself by including the ascx control on a page whose job is more or less just to host it for access from client-side script.

Shakiashaking answered 23/2, 2009 at 19:43 Comment(1)

Does the first part here work? I have to send JSON data to a function in an ascx.cs file and would rather not have to refactor this ascx markup and code into its containing aspx page. – Mclaren 7/9, 2016 at 13:14

S

2

I don't think it will be possible, as user controls aren't meant to be accessible externally (outside of a page). I suggest just using a script service (a web service).

Saxony answered 23/2, 2009 at 19:43 Comment(0)

A

2

What about creating the method on the .aspx page that does what it needs to with the information from the control? I know people go back and fourth on what controls are supposed to contain or not contain, but if the control only contains properties and objects, I would think having the function in the .aspx page could work for you. Obviously there would be many trade-offs.

Acute answered 23/2, 2009 at 19:51 Comment(0)

G

2

This is an example of rendering a user control through a jQuery web service call.

Garrott answered 24/2, 2009 at 19:33 Comment(2)

+1. This is article that got me started with jQuery and PageMethods. – Decalcomania 28/11, 2011 at 19:37

Link marked as having malware. Chrome and Firefox block it – Mclaren 7/9, 2016 at 13:11

R

2

Here is a way to get around the limitation of only having Page methods (ScriptMethod) available in ASPX pages. This example builds a proxy using a page base class and a special attribute to decorate methods in your ASCX page's code-behind and have those accessible via the client.

Creating a Page method (ScriptMethod) within an ASCX user control using AJAX, JSON, base classes and reflection

Roughneck answered 5/11, 2009 at 3:29 Comment(1)

It looks like your link is dead. – Inmate 17/2, 2011 at 21:4

A

1

I would create a Generic Handler (.ashx) which Loads the control and writes its rendered HTML to the Response.

Anthiathia answered 24/2, 2009 at 1:46 Comment(0)

B

0

You can write method GetDate() in Default.aspx or an other aspx file AND YOU CAN CALL THAT METHOD FROM .ASCX FILE.

Ex:

In UserControl.ascx:

$.ajax({
 type: "POST",
 url: "Default.aspx/GetDate",
 data: "{}",
 contentType: "application/json; charset=utf-8",
 dataType: "json",
 success: function(msg) {
 // Replace the div's content with the page method's return.
 $("#Result").text(msg.d);
}

});

In Default.aspx.cs:

Public void GetDate() //Public static void { //your code here }

Babbling answered 30/5, 2014 at 16:50 Comment(0)

Recommended topics

Hot tags