AjaxOptions Class

Visual Studio 2010

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)

public class AjaxOptions

The AjaxOptions type exposes the following members.

Public methodAjaxOptionsInitializes a new instance of the AjaxOptions class.

Public propertyConfirmGets or sets the message to display in a confirmation window before a request is submitted.
Public propertyHttpMethodGets or sets the HTTP request method ("Get" or "Post").
Public propertyInsertionModeGets or sets the mode that specifies how to insert the response into the target DOM element.
Public propertyLoadingElementIdGets or sets the id attribute of an HTML element that is displayed while the Ajax function is loading.
Public propertyOnBeginGets or sets the name of the JavaScript function to call immediately before the page is updated.
Public propertyOnCompleteGets or sets the JavaScript function to call when response data has been instantiated but before the page is updated.
Public propertyOnFailureGets or sets the JavaScript function to call if the page update fails.
Public propertyOnSuccessGets or sets the JavaScript function to call after the page is successfully updated.
Public propertyUpdateTargetIdGets or sets the ID of the DOM element to update by using the response from the server.
Public propertyUrlGets or sets the URL to make the request to.

Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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>
    Page Rendered: <%= DateTime.Now.ToLongTimeString() %>
<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>
<% } %>

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions