VirtualPathUtility.ToAppRelative Method (String)

 

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 Shared Function ToAppRelative (
	virtualPath As String
) As String

Parameters

virtualPath
Type: System.String

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

Return Value

Type: System.String

The application-relative path representation of virtualPath.

Exception Condition
ArgumentException

virtualPath is null.

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.

Dim sb2 As New StringBuilder()
Dim pathstring1 As String = 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())

.NET Framework
Available since 2.0
Return to top
Show: