UrlHelper.RouteUrl Method (String, Object, String)

Generates a fully qualified URL for the specified route values by using a route name and the protocol to use.

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

'Declaration
Public Overridable Function RouteUrl ( _
	routeName As String, _
	routeValues As Object, _
	protocol As String _
) As String
'Usage
Dim instance As UrlHelper 
Dim routeName As String 
Dim routeValues As Object 
Dim protocol As String 
Dim returnValue As String 

returnValue = instance.RouteUrl(routeName, _
	routeValues, protocol)

Parameters

routeName
Type: System.String
The name of the route that is used to generate the 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. The object is typically created by using object initializer syntax.
protocol
Type: System.String
The protocol for the URL, such as "http" or "https".

Return Value

Type: System.String
The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Show: