This documentation is archived and is not being maintained.

VirtualPathUtility.ToAppRelative Method (String)

Note: This method is new in the .NET Framework version 2.0.

Converts a virtual path to an application-relative path using the application virtual path that is in the AppDomainAppVirtualPath property.

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

public static string ToAppRelative (
	string virtualPath
)
public static String ToAppRelative (
	String virtualPath
)
public static function ToAppRelative (
	virtualPath : String
) : String

Parameters

virtualPath

The virtual path to convert to an application-relative path.

Return Value

The application-relative path representation of virtualPath.

Exception typeCondition

ArgumentException

virtualPath is a null reference (Nothing in Visual Basic).

If the virtual path for the application is "myapp" and the virtual path "/myApp/sub/default.asp" is passed into the ToAppRelative method, the resulting application-relative path is "~/sub/default.aspx".

If virtualPath does not start with the current application path, the ToAppRelative method returns the virtual path unchanged.

If virtualPath is the same as the application path, the root operator (the tilde [~]), is returned. For example, the current application virtual directory path can be accessed from the AppDomainAppVirtualPath property.

The following code example demonstrates how to use the IsAbsolute, IsAppRelative, and ToAppRelative methods.

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());

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: