AjaxExtensions.RouteLink Method (AjaxHelper, String, Object, AjaxOptions)

Returns an anchor element that contains the virtual path for the specified route values; when the link is clicked, a request is made to the virtual path asynchronously by using JavaScript.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function RouteLink ( _
    ajaxHelper As AjaxHelper, _
    linkText As String, _
    routeValues As Object, _
    ajaxOptions As AjaxOptions _
) As MvcHtmlString
public static MvcHtmlString RouteLink(
    this AjaxHelper ajaxHelper,
    string linkText,
    Object routeValues,
    AjaxOptions ajaxOptions
)
[ExtensionAttribute]
public:
static MvcHtmlString^ RouteLink(
    AjaxHelper^ ajaxHelper, 
    String^ linkText, 
    Object^ routeValues, 
    AjaxOptions^ ajaxOptions
)

Parameters

  • linkText
    Type: System.String
    The inner text of the anchor element.
  • routeValues
    Type: System.Object
    An object that contains the parameters for a route. The parameters are retrieved through reflection by examining the properties of the object. This object is typically created by using object initializer syntax.

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

The RouteLink method renders an anchor (a) element that links to a URL, which could resolve to an action method, a file, a folder, or some other resource.

See Also

Reference

AjaxExtensions Class

RouteLink Overload

System.Web.Mvc.Ajax Namespace