AjaxOptions Class
Represents option settings for running AJAX scripts in an MVC application.
Namespace:
System.Web.Mvc.Ajax
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
The AjaxOptions type exposes the following members.
| Name | Description | |
|---|---|---|
|
|
Confirm | Gets or sets the message to display in a confirmation window before a request is submitted. |
|
|
HttpMethod | Gets or sets the HTTP request method ("Get" or "Post"). |
|
|
InsertionMode | Gets or sets the mode that specifies how to insert the response into the target DOM element. |
|
|
LoadingElementId | Gets or sets the id attribute of an HTML element that is displayed while the Ajax function is loading. |
|
|
OnBegin | Gets or sets the name of the JavaScript function to call immediately before the page is updated. |
|
|
OnComplete | Gets or sets the JavaScript function to call when response data has been instantiated but before the page is updated. |
|
|
OnFailure | Gets or sets the JavaScript function to call if the page update fails. |
|
|
OnSuccess | Gets or sets the JavaScript function to call after the page is successfully updated. |
|
|
UpdateTargetId | Gets or sets the ID of the DOM element to update by using the response from the server. |
|
|
Url | Gets or sets the URL to make the request to. |
| Name | Description | |
|---|---|---|
|
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
This class provides options for methods of the AjaxHelper and AjaxExtensions classes.
The following example shows how to use the AjaxOptions class to set the ID of the elements that are used to display the status message and to enter text.
<h2><%= Html.Encode(ViewData["Message"]) %></h2> <p> Page Rendered: <%= DateTime.Now.ToLongTimeString() %> </p> <span id="status">No Status</span> <br /> <%= Ajax.ActionLink("Update Status", "GetStatus", new AjaxOptions{UpdateTargetId="status" }) %> <br /><br /> <% using(Ajax.BeginForm("UpdateForm", new AjaxOptions{UpdateTargetId="textEntered"})) { %> <%= Html.TextBox("textBox1","Enter text")%> <input type="submit" value="Submit"/><br /> <span id="textEntered">Nothing Entered</span> <% } %>