Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

VirtualPathData Class

.NET Framework 4

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

System.Object
  System.Web.Routing.VirtualPathData

Namespace:  System.Web.Routing
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
public class VirtualPathData

The VirtualPathData type exposes the following members.

  Name Description
Public method VirtualPathData Initializes a new instance of the VirtualPathData class.
Top
  Name Description
Public property DataTokens Gets the collection of custom values for the route definition.
Public property Route Gets or sets the route that is used to create the URL.
Public property VirtualPath Gets or sets the URL that was created from the route definition.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.

C#
VB
Copy 

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

.NET Framework

Supported in: 4, 3.5 SP1

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ