AjaxExtensions.ActionLink Method (AjaxHelper, String, String, String, String, String, String, RouteValueDictionary, AjaxOptions, IDictionary<String, Object>)

Article
02/21/2011

Returns an anchor element that contains the URL to the specified action method; when the action link is clicked, the action method is invoked asynchronously by using JavaScript.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function ActionLink ( _
    ajaxHelper As AjaxHelper, _
    linkText As String, _
    actionName As String, _
    controllerName As String, _
    protocol As String, _
    hostName As String, _
    fragment As String, _
    routeValues As RouteValueDictionary, _
    ajaxOptions As AjaxOptions, _
    htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString

public static MvcHtmlString ActionLink(
    this AjaxHelper ajaxHelper,
    string linkText,
    string actionName,
    string controllerName,
    string protocol,
    string hostName,
    string fragment,
    RouteValueDictionary routeValues,
    AjaxOptions ajaxOptions,
    IDictionary<string, Object> htmlAttributes
)

[ExtensionAttribute]
public:
static MvcHtmlString^ ActionLink(
    AjaxHelper^ ajaxHelper, 
    String^ linkText, 
    String^ actionName, 
    String^ controllerName, 
    String^ protocol, 
    String^ hostName, 
    String^ fragment, 
    RouteValueDictionary^ routeValues, 
    AjaxOptions^ ajaxOptions, 
    IDictionary<String^, Object^>^ htmlAttributes
)

Parameters

ajaxHelper
Type: System.Web.Mvc.AjaxHelper
The AJAX helper.

linkText
Type: System.String
The inner text of the anchor element.

actionName
Type: System.String
The name of the action method.

controllerName
Type: System.String
The name of the controller.

protocol
Type: System.String
The protocol for the URL, such as "http" or "https".

hostName
Type: System.String
The host name for the URL.

fragment
Type: System.String
The URL fragment name (the anchor name).

routeValues
Type: System.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route.

ajaxOptions
Type: System.Web.Mvc.Ajax.AjaxOptions
An object that provides options for the asynchronous request.

htmlAttributes
Type: System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes to set for the element.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An anchor element.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type AjaxHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentException	The linkText parameter is null reference (Nothing in Visual Basic) or empty.

Remarks

This method renders an anchor element. When the user clicks the link, MVC asynchronously invokes the specified action method via an HTTP POST request. The response of that action method can be used to update a specified DOM element, depending on which AjaxOptions are specified.

The htmlAttributes parameter consists of an object that contains name/value pairs. The attributes that are specified in the name/value pairs depend on the HTML element that is being rendered. For example, for an anchor (a) element, you might provide the following anonymous object:

new { target="_self", name="summary" }

New With {.target="_self", .name="summary" }