LinkExtensions.RouteLink Method (HtmlHelper, String, String, RouteValueDictionary, IDictionary<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)

public static string RouteLink(
	this HtmlHelper htmlHelper,
	string linkText,
	string routeName,
	RouteValueDictionary routeValues,
	IDictionary<string, Object> htmlAttributes
)

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.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route.
htmlAttributes
Type: System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes for the element.

Return Value

Type: System.String
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 Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
ArgumentException

Thrown if the linkText parameter is null or empty.

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

Community Additions

Show: