FilePathAbsoluteToRelativePath Method

This helper method can be used to convert an absolute path to one that is relative to the given base path.

Definition

Namespace: Sandcastle.Core
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0

public static string AbsoluteToRelativePath(
	string basePath,
	string absolutePath
)

VBView Source Request Example

Public Shared Function AbsoluteToRelativePath ( 
	basePath As String,
	absolutePath As String
) As String

C++View Source Request Example

public:
static String^ AbsoluteToRelativePath(
	String^ basePath, 
	String^ absolutePath
)

F#View Source Request Example

static member AbsoluteToRelativePath : 
        basePath : string * 
        absolutePath : string -> string

Parameters

basePath String: The base path
absolutePath String: An absolute path

Return Value

String
A path to the given absolute path that is relative to the given base path

Remarks

If the base path is null or empty, the current working folder is used.

Example

C#

string basePath = @"E:\DotNet\CS\TestProject\Source";
string absolutePath = @"E:\DotNet\CS\TestProject\Doc\Help.html";

string relativePath = FilePath.AbsoluteToRelativePath(basePath,
    absolutePath);

Console.WriteLine(relativePath);

// Results in: ..\Doc\Help.html

VB

Dim basePath As String = "E:\DotNet\CS\TestProject\Source"
Dim absolutePath As String = "E:\DotNet\CS\TestProject\Doc\Help.html"

Dim relativePath As String = _
    FilePath.AbsoluteToRelativePath(basePath, absolutePath);

Console.WriteLine(relativePath)

' Results in: ..\Doc\Help.html

C++

No code example is currently available or this language may not be supported.

F#

No code example is currently available or this language may not be supported.