AjaxExtensions.RouteLink Method (AjaxHelper, String, 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

C++

JScript

static member RouteLink : 
        ajaxHelper:AjaxHelper * 
        linkText:string * 
        routeName:string * 
        routeValues:Object * 
        ajaxOptions:AjaxOptions -> MvcHtmlString

Parameters

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

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

routeName: Type: System.String
The name of the route to use to obtain the form post URL.

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.

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

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 https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108).aspx or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).aspx.

Exceptions

Exception	Condition
ArgumentException	The linkText parameter is a 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.