Control.GetRouteUrl Method (RouteValueDictionary)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the URL that corresponds to a set of route parameters.

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

Public Function GetRouteUrl (
	routeParameters As RouteValueDictionary
) As String

Parameters

routeParameters
Type: System.Web.Routing.RouteValueDictionary

The route parameters.

Return Value

Type: System.String

The URL that corresponds to the specified route parameters.

This method is provided for coding convenience. It is equivalent to calling the RouteCollection.GetVirtualPath(RequestContext, RouteValueDictionary) method.

The following example shows how to call this method to get the URL of a route that has parameters that are named productid and category. This example assumes that you have created a HyperLink control that is named HyperLink1.

HyperLink1.NavigateUrl = HyperLink1.GetRouteUrl(
  new RouteValueDictionary {productId="1", category="widgets"})

.NET Framework
Available since 4.0
Return to top
Show: