{"id":40,"date":"2011-10-21T08:08:00","date_gmt":"2011-10-21T08:08:00","guid":{"rendered":"https:\/\/wdev-blog.azurewebsites.net\/index.php\/2011\/10\/21\/placing-a-web-method-in-a-page\/"},"modified":"2011-10-21T08:08:00","modified_gmt":"2011-10-21T08:08:00","slug":"placing-a-web-method-in-a-page","status":"publish","type":"post","link":"http:\/\/panahy.nl\/index.php\/2011\/10\/21\/placing-a-web-method-in-a-page\/","title":{"rendered":"Placing a Web Method in a Page"},"content":{"rendered":"
In most cases, it makes sense to create a separate web service to handle your ASP.NET<\/a> AJAX callbacks.<\/div>\n
This approach generally results in clearer pages and makes it easier to debug and refine your code.<\/div>\n
However, in some situations you may decide you have one or more web methods that are designed<\/div>\n
explicitly for use on a single page and that really shouldn’t be reused in other parts of the application. In<\/div>\n
this case, you may choose to create a dedicated web service for each page, or you might choose to move<\/div>\n
the web service code into the page.<\/div>\n
<\/div>\n
\n
Placing the web method code in the page is easy\u2014in fact, all you need is a simple bit of cut-andpaste.<\/div>\n
First, copy your web method (complete with the WebMethod attribute) into the code-behind class<\/div>\n
for your page. Then, change it to a static method, and add the System.Web.Script.Services.ScriptMethod<\/div>\n
attribute. Here’s an example where the web method (named GetTerritoriesInRegion) is placed in a web<\/div>\n
page named WebServiceCallback_PageMethods:<\/div>\n<\/div>\n
<\/div>\n
\n
public partial class WebServiceCallback_PageMethods : System.Web.UI.Page<\/span><\/div>\n
{<\/span><\/div>\n
   [System.Web.Services.WebMethod()]<\/span><\/div>\n
   [System.Web.Script.Services.ScriptMethod()]<\/span><\/div>\n
   public static List<Territory> GetTerritoriesInRegion(int regionID)<\/span><\/div>\n
   {<\/span><\/div>\n
      \/\/ Farm the work out to the web service class.<\/span><\/div>\n
      TerritoriesService service = new TerritoriesService();<\/span><\/div>\n
      return service.GetTerritoriesInRegion(regionID);<\/span><\/div>\n
   }<\/span><\/div>\n
…<\/span><\/div>\n
}<\/span><\/div>\n<\/div>\n
<\/div>\n
\n
Next, set the ScriptManager.EnablePageMethods property to true, and remove the reference in the<\/div>\n
<Services> section of the ScriptManager (assuming you don’t want to use any non-page web services):<\/div>\n

<\/span><\/div>\n
<asp:ScriptManager ID=”ScriptManager1″ runat=”server” EnablePageMethods=”true”><\/span><\/div>\n
<\/asp:ScriptManager><\/span><\/div>\n
<\/div>\n
Finally, change your JavaScript code so it calls the method through the PageMethods object, as<\/div>\n
shown here:<\/div>\n

<\/span><\/div>\n
PageMethods.GetTerritoriesInRegion(regionID, OnRequestComplete, OnError);<\/span><\/div>\n

<\/span><\/div>\n
The PageMethods object exposes all the web methods you’ve added to the current web page.<\/div>\n
One advantage of placing a web method in a page is that the method is no longer exposed through<\/div>\n
an .asmx file. As a result, it’s not considered part of a public web service, and it’s not as easy for someone<\/div>\n
else to discover. This is appealing if you’re trying to hide your web services from curious users.<\/div>\n
Another reason you might choose to code your web methods in the page class is to read values from<\/div>\n
view state or the controls on the page. When you trigger a page method, a stripped-down version of the<\/div>\n
page life cycle executes, just like with the ASP.NET<\/a> client callback feature you saw in Chapter 29. Of<\/div>\n
course, there’s no point in trying to modify page details because the page isn’t being rerendered, so any<\/div>\n
changes you make will simply be discarded.<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

In most cases, it makes sense to create a separate web service to handle your ASP.NET AJAX callbacks. This approach generally results in clearer pages and makes it easier to debug and refine your code. However, in some situations you may decide you have one or more web methods that are designed explicitly for use … Continue reading “Placing a Web Method in a Page”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[32,34,35],"tags":[],"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"post-thumbnail":false},"uagb_author_info":{"display_name":"Pouya Panahy","author_link":"http:\/\/panahy.nl\/index.php\/author\/pouya\/"},"uagb_comment_info":0,"uagb_excerpt":"In most cases, it makes sense to create a separate web service to handle your ASP.NET AJAX callbacks. This approach generally results in clearer pages and makes it easier to debug and refine your code. However, in some situations you may decide you have one or more web methods that are designed explicitly for use…","_links":{"self":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts\/40"}],"collection":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/comments?post=40"}],"version-history":[{"count":0,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/posts\/40\/revisions"}],"wp:attachment":[{"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/media?parent=40"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/categories?post=40"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/panahy.nl\/index.php\/wp-json\/wp\/v2\/tags?post=40"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}