Export (0) Print
Expand All

VirtualPathUtility Class

Provides utility methods for common virtual path operations.

System.Object
  System.Web.VirtualPathUtility

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

public static class VirtualPathUtility

The VirtualPathUtility type exposes the following members.

  NameDescription
Public methodStatic memberAppendTrailingSlashAppends the literal slash mark (/) to the end of the virtual path, if one does not already exist.
Public methodStatic memberCombineCombines a base path and a relative path.
Public methodStatic memberGetDirectoryReturns the directory portion of a virtual path.
Public methodStatic memberGetExtensionRetrieves the extension of the file that is referenced in the virtual path.
Public methodStatic memberGetFileNameRetrieves the file name of the file that is referenced in the virtual path.
Public methodStatic memberIsAbsoluteReturns a Boolean value indicating whether the specified virtual path is absolute; that is, it starts with a literal slash mark (/).
Public methodStatic memberIsAppRelativeReturns a Boolean value indicating whether the specified virtual path is relative to the application.
Public methodStatic memberMakeRelativeReturns the relative virtual path from one virtual path containing the root operator (the tilde [~]) to another.
Public methodStatic memberRemoveTrailingSlashRemoves a trailing slash mark (/) from a virtual path.
Public methodStatic memberToAbsolute(String)Converts a virtual path to an application absolute path.
Public methodStatic memberToAbsolute(String, String)Converts a virtual path to an application absolute path using the specified application path.
Public methodStatic memberToAppRelative(String)Converts a virtual path to an application-relative path using the application virtual path that is in the AppDomainAppVirtualPath property.
Public methodStatic memberToAppRelative(String, String)Converts a virtual path to an application-relative path using a specified application path.
Top

The VirtualPathUtility class provides utility methods for common operations involving virtual paths. For ASP.NET server controls and server code, virtual paths using the Web application root operator, the tilde (~), commonly are used instead of relative and absolute paths. For more information, see ASP.NET Web Project Paths.

Use the VirtualPathUtility class when you need to convert application-relative paths to absolute virtual paths, as might be the case in developing a custom Web service handler.

An absolute virtual path starts with the literal slash mark (/). A relative virtual path is relative to the application root directory, if it is just a tilde (~) or starts with the tilde and a double backslash (~\\) or the tilde and a slash mark (~/). Making a virtual path relative makes the path independent of the application.

The virtual directory for the application can be obtained from the AppDomainAppVirtualPath and ApplicationPath properties.

NoteNote

The VirtualPathUtility class is not intended for security or canonicalization purposes. For more information about Web application security, see Overview of Web Application Security Threats. For generic URL processing functionality, see Uri.

The following code example demonstrates how to use the VirtualPathUtility class and some of its methods. First, the FilePath property generates the virtual path to the Web page. The GetFileName, GetExtension, and GetDirectory methods return information about the virtual path. Next, the CurrentExecutionFilePath property generates a virtual path of the current request, which might be different from the FilePath property, if a Redirect method was called. The IsAbsolute, IsAppRelative, and ToAppRelative methods return information about the virtual path.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  protected void Page_Load(object sender, EventArgs e)
  {
    StringBuilder sb = new StringBuilder();
    String pathstring = Context.Request.FilePath.ToString();
    sb.Append("Current file path = " + pathstring + "<br />");
    sb.Append("File name = " + VirtualPathUtility.GetFileName(pathstring).ToString() + "<br />");
    sb.Append("File extension = " + VirtualPathUtility.GetExtension(pathstring).ToString() + "<br />");
    sb.Append("Directory = " + VirtualPathUtility.GetDirectory(pathstring).ToString() + "<br />");
    Response.Write(sb.ToString());

    StringBuilder sb2 = new StringBuilder();
    String pathstring1 = Context.Request.CurrentExecutionFilePath.ToString();
    sb2.Append("Current Executing File Path = " + pathstring1.ToString() + "<br />");
    sb2.Append("Is Absolute = " + VirtualPathUtility.IsAbsolute(pathstring1).ToString() + "<br />");
    sb2.Append("Is AppRelative = " + VirtualPathUtility.IsAppRelative(pathstring1).ToString() + "<br />");
    sb2.Append("Make AppRelative = " + VirtualPathUtility.ToAppRelative(pathstring1).ToString() + "<br />");
    Response.Write(sb2.ToString());
}
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>VirtualPathUtility Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

    </div>
    </form>
</body>
</html>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft