HtmlHelper.GenerateRouteLink Method (RequestContext, RouteCollection, String, String, String, String, String, RouteValueDictionary, IDictionary(String, Object))

Generates an HTML anchor element (a element) that links to the specified URL route, and enables the user to specify the communication protocol, name of the host, and a URL fragment.

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

public static function GenerateRouteLink(
	requestContext : RequestContext, 
	routeCollection : RouteCollection, 
	linkText : String, 
	routeName : String, 
	protocol : String, 
	hostName : String, 
	fragment : String, 
	routeValues : RouteValueDictionary, 
	htmlAttributes : IDictionary<String, Object>
) : String

Parameters

requestContext
Type: System.Web.Routing.RequestContext

The context of the HTTP request.

routeCollection
Type: System.Web.Routing.RouteCollection

The collection of URL routes.

linkText
Type: System.String

The text caption to display for the link.

routeName
Type: System.String

The name of the route that is used to return a virtual path.

protocol
Type: System.String

The communication protocol, such as HTTP or HTTPS. If this parameter is a null reference (Nothing in Visual Basic), the protocol defaults to HTTP.

hostName
Type: System.String

The name of the host.

fragment
Type: System.String

The fragment identifier.

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 HTML element that links to the specified URL route.
Show: