Control.GetRouteUrl Method (Object) (System.Web.UI)

.NET Framework Class Library

Control..::.GetRouteUrl Method (Object)

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 Object _
) As String

public string GetRouteUrl(
	Object routeParameters
)

public:
String^ GetRouteUrl(
	Object^ routeParameters
)

member GetRouteUrl : 
        routeParameters:Object -> string

Parameters

routeParameters: Type: System..::.Object
The route parameters.

Return Value

Type: System..::.String
The URL that corresponds to the specified route parameters.

Remarks

This method is provided for coding convenience. It is equivalent to calling the RouteCollection..::.GetVirtualPath(RequestContext, RouteValueDictionary) method. This method converts the object that is passed in routeParameters to a RouteValueDictionary object by using the RouteValueDictionary..::.RouteValueDictionary(Object) constructor.

Examples

The following example shows how to call the Control..::.GetRouteUrl 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 With {.productid = "1", .category = "widgets"})

HyperLink1.NavigateUrl = HyperLink1.GetRouteUrl(
  new { productid = "1", category = "widgets" });

Version Information

.NET Framework

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Control Class

GetRouteUrl Overload

System.Web.UI Namespace

Other Resources

ASP.NET Routing

Advertise Here