UrlHelper.RouteUrl Method

 

Generates a fully qualified URL.

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

NameDescription
System_CAPS_pubmethodRouteUrl(Object)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethodRouteUrl(RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethodRouteUrl(String)

Generates a fully qualified URL for the specified route name.

System_CAPS_pubmethodRouteUrl(String, Object)

Generates a fully qualified URL for the specified route values by using a route name.

System_CAPS_pubmethodRouteUrl(String, Object, String)

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

System_CAPS_pubmethodRouteUrl(String, RouteValueDictionary)

Generates a fully qualified URL for the specified route values by using a route name.

System_CAPS_pubmethodRouteUrl(String, RouteValueDictionary, String, String)

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

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

Return to top

UrlHelper.RouteUrl Method (Object)

Generates a fully qualified URL for the specified route values.

Public Overridable Function RouteUrl (
	routeValues As Object
) As String

Parameters

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.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

Return to top

UrlHelper.RouteUrl Method (RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

Public Overridable Function RouteUrl (
	routeValues As RouteValueDictionary
) As String

Parameters

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

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

Return to top

UrlHelper.RouteUrl Method (String)

Generates a fully qualified URL for the specified route name.

Public Overridable Function RouteUrl (
	routeName As String
) As String

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

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

Return to top

UrlHelper.RouteUrl Method (String, Object)

Generates a fully qualified URL for the specified route values by using a route name.

Public Overridable Function RouteUrl (
	routeName As String,
	routeValues As Object
) As String

Parameters

routeName
Type: System.String

The name of the route that is used to generate 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.

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

Return to top

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.

Public Overridable Function RouteUrl (
	routeName As String,
	routeValues As Object,
	protocol As String
) As String

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

Return to top

UrlHelper.RouteUrl Method (String, RouteValueDictionary)

Generates a fully qualified URL for the specified route values by using a route name.

Public Overridable Function RouteUrl (
	routeName As String,
	routeValues As RouteValueDictionary
) As String

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

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

Return to top

UrlHelper.RouteUrl Method (String, RouteValueDictionary, String, String)

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

Public Overridable Function RouteUrl (
	routeName As String,
	routeValues As RouteValueDictionary,
	protocol As String,
	hostName As String
) As String

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

protocol
Type: System.String

The protocol for the URL, such as "http" or "https".

hostName
Type: System.String

The host name for the URL.

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

Return to top
Show: