VirtualPathUtility.ToAppRelative Method

Definition

Converts a virtual path into an application-relative path.

Overloads

ToAppRelative(String)

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

ToAppRelative(String, String)

Converts a virtual path to an application-relative path using a specified application path.

ToAppRelative(String)

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

public:
 static System::String ^ ToAppRelative(System::String ^ virtualPath);
public static string ToAppRelative (string virtualPath);
static member ToAppRelative : string -> string
Public Shared Function ToAppRelative (virtualPath As String) As String

Parameters

virtualPath
String

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

Returns

The application-relative path representation of virtualPath.

Exceptions

virtualPath is null.

Examples

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

Remarks

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.

See also

ToAppRelative(String, String)

Converts a virtual path to an application-relative path using a specified application path.

public:
 static System::String ^ ToAppRelative(System::String ^ virtualPath, System::String ^ applicationPath);
public static string ToAppRelative (string virtualPath, string applicationPath);
static member ToAppRelative : string * string -> string
Public Shared Function ToAppRelative (virtualPath As String, applicationPath As String) As String

Parameters

virtualPath
String

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

applicationPath
String

The application path to use to convert virtualPath to a relative path.

Returns

The application-relative path representation of virtualPath.

Remarks

The ToAppRelative overload of the ToAppRelative method uses applicationPath rather than the current application path. If virtualPath does not start with applicationPath, the ToAppRelative method returns the virtual path unchanged.

See also

Applies to