VirtualPathData Class


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

Represents information about the route and virtual path that are the result of generating a URL with the ASP.NET routing framework.

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


public class VirtualPathData

System_CAPS_pubmethodVirtualPathData(RouteBase, String)

Initializes a new instance of the VirtualPathData class.


Gets the collection of custom values for the route definition.


Gets or sets the route that is used to create the URL.


Gets or sets the URL that was created from the route definition.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

When you generate a URL by using the ASP.NET routing framework, an instance of the VirtualPathData class is returned by the GetVirtualPath method. The VirtualPathData class contains information about the route that matched the values that you provided when you called the GetVirtualPath method. The VirtualPathData object also contains the generated URL in the VirtualPath property. The DataTokens property contains custom values for the route. You retrieve the route object that is used for generating the URL by using the Route property.

The following example shows a control that creates a URL that is based on a route that has parameters that are named action and categoryName.

RouteValueDictionary parameters = new RouteValueDictionary { { "action", "show" }, { "categoryName", "bikes" } };
VirtualPathData vpd = RouteTable.Routes.GetVirtualPath(null, parameters);
HyperLink1.NavigateUrl = vpd.VirtualPath;

.NET Framework
Available since 3.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top