Uri.IsBaseOf Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Determines whether the current Uri instance is a base of the specified Uri instance.

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

Syntax

'Declaration
Public Function IsBaseOf ( _
    uri As Uri _
) As Boolean
public bool IsBaseOf(
    Uri uri
)

Parameters

Return Value

Type: System.Boolean
true if the current Uri instance is a base of uri; otherwise, false.

Remarks

IsBaseOf is used to compare the current Uri instance to a specified Uri to determine whether this URI is a base for the specified Uri. When comparing two Uri objects to determine a base relationship, the user information (UserInfo) is not evaluated. When comparing two URIs (uri1 and uri2), uri1 is the base of uri2 if, when you ignore everything in uri2 after the last slash (/), the two URIs are identical. Using http://host/path/path/file?query as the base URI, the following table shows whether it is a base for other URIs.

URI

http://host/path/path/file?query is base of

http://host/path/path/file/

yes

http://host/path/path/#fragment

yes

http://host/path/path/MoreDir/"

yes

http://host/path/path/OtherFile?Query

yes

http://host/path/path/

yes

http://host/path/path/file

yes

http://host/path/path

no

http://host/path/path?query

no

http://host/path/path#Fragment

no

http://host/path/path2/

no

http://host/path/path2/MoreDir

no

http://host/path/File

no

Examples

This example creates a Uri instance that represents a base Uri instance. It then creates a second Uri instance from a string. It calls IsBaseOf to determine whether the base instance is the base of the second instance. The outcome is written to the console.

' Create a base Uri.
Dim baseUri As New Uri("https://www.contoso.com/")

' Create a new Uri from a string.
Dim uriAddress As New Uri("https://www.contoso.com/index.htm?date=today")

' Determine whether BaseUri is a base of UriAddress.  
If baseUri.IsBaseOf(uriAddress) Then
    Console.WriteLine("{0} is the base of {1}", baseUri, uriAddress)
End If
      // Create a base Uri.
      Uri baseUri = new Uri("https://www.contoso.com/");

      // Create a new Uri from a string.
      Uri uriAddress2 = new Uri("https://www.contoso.com/index.htm?date=today"); 

      // Determine whether BaseUri is a base of UriAddress.  
      if (baseUri.IsBaseOf(uriAddress2)) {
          outputBlock.Text += baseUri;
          outputBlock.Text += " is the base of ";
          outputBlock.Text += uriAddress2;
          outputBlock.Text += "\n";
      }

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference