LinkExtensions.RouteLink Method (HtmlHelper, String, String, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function RouteLink ( _
	htmlHelper As HtmlHelper, _
	linkText As String, _
	routeName As String, _
	routeValues As Object _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper 
Dim linkText As String 
Dim routeName As String 
Dim routeValues As Object 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.RouteLink(linkText, _
	routeName, routeValues)

Parameters

htmlHelper: Type: System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.

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

routeName: Type: System.String
The name of the route that is used to return a virtual path.

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. The object is typically created by using object initializer syntax.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An anchor element (a element).

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper. 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).

Exceptions

Exception	Condition
ArgumentException	The linkText parameter is Nothing or empty.

Remarks

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