Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

AjaxOptions Class

 

Represents option settings for running Ajax scripts in an ASP.NET MVC application.

Namespace:   System.Web.Mvc.Ajax
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)

System.Object
  System.Web.Mvc.Ajax.AjaxOptions

public class AjaxOptions

NameDescription
System_CAPS_pubmethodAjaxOptions()

Initializes a new instance of the AjaxOptions class.

NameDescription
System_CAPS_pubpropertyAllowCache

System_CAPS_pubpropertyConfirm

Gets or sets the message to display in a confirmation window before a request is submitted.

System_CAPS_pubpropertyHttpMethod

Gets or sets the HTTP request method ("Get" or "Post").

System_CAPS_pubpropertyInsertionMode

Gets or sets the mode that specifies how to insert the response into the target DOM element.

System_CAPS_pubpropertyLoadingElementDuration

Gets or sets a value, in milliseconds, that controls the duration of the animation when showing or hiding the loading element.

System_CAPS_pubpropertyLoadingElementId

Gets or sets the id attribute of an HTML element that is displayed while the Ajax function is loading.

System_CAPS_pubpropertyOnBegin

Gets or sets the name of the JavaScript function to call immediately before the page is updated.

System_CAPS_pubpropertyOnComplete

Gets or sets the JavaScript function to call when response data has been instantiated but before the page is updated.

System_CAPS_pubpropertyOnFailure

Gets or sets the JavaScript function to call if the page update fails.

System_CAPS_pubpropertyOnSuccess

Gets or sets the JavaScript function to call after the page is successfully updated.

System_CAPS_pubpropertyUpdateTargetId

Gets or sets the ID of the DOM element to update by using the response from the server.

System_CAPS_pubpropertyUrl

Gets or sets the URL to make the request to.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodToUnobtrusiveHtmlAttributes()

Returns the Ajax options as a collection of HTML attributes to support unobtrusive JavaScript.

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.

<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>
}

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

Return to top
Show:
© 2015 Microsoft