AjaxExtensions.RouteLink Method (AjaxHelper, String, String, RouteValueDictionary, 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)
'Declaration <ExtensionAttribute> _ Public Shared Function RouteLink ( _ ajaxHelper As AjaxHelper, _ linkText As String, _ routeName As String, _ routeValues As RouteValueDictionary, _ ajaxOptions As AjaxOptions _ ) As MvcHtmlString 'Usage Dim ajaxHelper As AjaxHelper Dim linkText As String Dim routeName As String Dim routeValues As RouteValueDictionary Dim ajaxOptions As AjaxOptions Dim returnValue As MvcHtmlString returnValue = ajaxHelper.RouteLink(linkText, _ routeName, routeValues, ajaxOptions)
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.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.
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) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).| Exception | Condition |
|---|---|
| ArgumentException | The linkText parameter is Nothing or empty. |
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.
Show: