RouteBase.GetVirtualPath Method (RequestContext, RouteValueDictionary)

 
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.

When overridden in a derived class, checks whether the route matches the specified values, and if so, generates a URL and retrieves information about the route.

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

public abstract VirtualPathData GetVirtualPath(
	RequestContext requestContext,
	RouteValueDictionary values
)

Parameters

requestContext
Type: System.Web.Routing.RequestContext

An object that encapsulates information about the requested route.

values
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

Return Value

Type: System.Web.Routing.VirtualPathData

An object that contains the generated URL and information about the route, or null if the route does not match values.

To generate a URL, you use the GetVirtualPath method of the RouteCollection class. That method calls the GetVirtualPath method for each route in the collection to determine whether that route matches the values in values and can therefore generate the URL.

.NET Framework
Available since 3.5
Return to top
Show: