Uri Class

Definition

Namespace:

Windows.Foundation

Defines an object that represents a Uniform Resource Identifier (URI) value and parses it into components. The Uri object is used by many other Windows Runtime APIs that are not necessarily confined to web browser scenarios.

.NET When programming with .NET, this type is hidden and developers should use System.Uri. See Remarks.

public ref class Uri sealed : IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(Windows.Foundation.IUriRuntimeClassFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class Uri final : IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Foundation.IUriRuntimeClassFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class Uri : IStringable

function Uri(baseUri, relativeUri)

Public NotInheritable Class Uri
Implements IStringable

Inheritance

Object Platform::Object IInspectable Uri

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IStringable

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

This example creates a Uri object that represents a Uniform Resource Identifier (URI) that's using the http protocol to access a website.

// The URI string
var uriToLaunch = "http://www.bing.com";

// Create a Uri object from the URI string
var uri = new Windows.Foundation.Uri(uriToLaunch);

// The URI string.
std::wstring uriToLaunch{ L"http://www.bing.com" };

// Create a Uri object from the URI string.
Windows::Foundation::Uri uri{ uriToLaunch };

// The URI string
var uriToLaunch = L"http://www.bing.com";

// Create a Uri object from the URI string
auto uri = ref new Windows::Foundation::Uri(uriToLaunch);

This example creates a Uri that uses the ms-appx protocol to access an image file in the app package.

// The URI string
var uriImage = "ms-appx:///images/SecondaryTileDefault-sdk.png";

// Create a Uri object from the URI string
var uri = new Windows.Foundation.Uri(uriImage);

// The URI string.
std::wstring uriImage{ L"ms-appx:///images/SecondaryTileDefault-sdk.png" };

// Create a Uri object from the URI string.
Windows::Foundation::Uri uri{ uriImage };

// The URI string
var uriImage = ;

// Create a Uri object from the URI string
auto uri = ref new Windows::Foundation::Uri(uriImage);

This example creates a Uri that uses the ms-appdata protocol to access a file in local app data store for your app.

// The URI string
var uriFile = "ms-appdata:///local/file.ext";

// Create a Uri object from the URI string
var uri = new Windows.Foundation.Uri(uriFile);

// The URI string.
std::wstring uriFile{ L"ms-appdata:///local/file.ext" };

// Create a Uri object from the URI string.
Windows::Foundation::Uri uri{ uriFile };

// The URI string
var uriFile = "ms-appdata:///local/file.ext";

// Create a Uri object from the URI string
auto uri = ref new Windows::Foundation::Uri(uriFile);

Remarks

Important

When programming with .NET, this class is hidden and developers should use the System.Uri class, which uses RFC 3987 rules to encode and decode Uniform Resource Identifier (URI). The Windows.Foundation.Uri class doesn't percent-encode non-ASCII characters in Uniform Resource Identifier (URI) where the scheme refers to a Windows file path (like ms-appx:). Windows.Foundation.Uri also interprets percent-encoding using the user's current codepage.

The available members of System.Uri are similar but different than the members of Windows.Foundation.Uri, and some of the basic behaviors described in this topic are different. For more info on the encoding differences and what members are available, see System.Uri (particularly the Remarks).

Here is a breakdown of the parts of an example Uniform Resource Identifier (URI):

scheme://username:password@host:port/path.extension?query#fragment

For example:

http://msdn.microsoft.com/library/windows/apps/windows.foundation.uri.aspx?cs-save-lang=1&cs-lang=cpp#code-snippet-1

In this example:

• scheme is http
• host is msdn.microsoft.com
• domain is microsoft.com (a subset of host)
• extension is aspx
• query is cs-save-lang=1&cs-lang=cpp
• fragment is code-snippet-1

Note

username:password@ preceding the host are mainly relevant for File Transfer Protocol (FTP) Uniform Resource Identifier (URI). File Transfer Protocol (FTP) URIs have limited support in Windows Runtime; see "Transferring data in the background" (HTML or XAML).

Important

Not all possible schemes are usable by a Windows Runtime app. Notably, the file: scheme is blocked. It's possible to create a Uri object that uses schemes that a Windows Runtime app won't support, and you're blocked when you try to apply that Uri as an input value for an API call, not when creating the object.

URI schemes that are specific to a Windows Runtime app

Windows Runtime has several schemes that are unique to a Windows Runtime app, and these refer to assets that are part of the app. Generally, these schemes are what you can use instead of the file: scheme, to refer to packaged files and other assets that you've included as part of your app package, or assets that are otherwise associated with an installed app:

• ms-appx: references the app's locally-packaged files.
• ms-appx-web: also references the app's locally-packaged files but loads them in a web context. This is often necessary if you are accessing assets for use by WebView, or writing HTML/JavaScript apps and requesting from an HTML page. For more info see URI schemes or How to reference content (HTML).
• ms-appdata: refers to app files that come from the app's local, roaming, and temporary data folders. For more info see URI schemes or Store and retrieve settings and other app data.
• ms-resource: refers to app resources in the Resource Management System. For more info, see Localize strings in your UI and app package manifest.

Each of these schemes ignores many of the component parts of a Uniform Resource Identifier (URI) that are intended for other schemes (for example, Query and Fragment). Also, certain components are explicitly disallowed and cause the Uri value using these schemes to be treated as an invalid input (for example UserName and Password values in an ms-appx: Uri scheme will invalidate a Uri). For more info, see URI schemes.

In most cases, you use these schemes with three slashes (example: ms-appx:///page.html), which references the root of the current app, using the current app as authority. Usages with two slashes are possible, but might require specifying the authority name explicitly. Usages with two slashes can refer to a package dependency as the authority, or can refer to relative locations within the app. For more info, see URI schemes.

Absolute and relative URIs

At a code level, the Windows Runtime does not support relative Uniform Resource Identifier (URI). All Uri objects you create must represent an absolute Uniform Resource Identifier (URI). The schemes listed in the previous section are actually absolute Uniform Resource Identifier (URI), because the host and authority are implicit for each scheme and the remainder of the path is evaluated under that authority.

Launching an app by URI scheme

The Uniform Resource Identifier (URI) scheme of a Uri value can be used to launch other apps that are associated with that particular scheme. For more info, see Launch the default app for a URI).

Constructors

Uri(String, String)	Initializes a new Uri by combining a base Uniform Resource Identifier (URI) and a relative Uniform Resource Identifier (URI). Initializing the Uri also parses the combined string and populates the Uri properties that represent Uniform Resource Identifier (URI) components.
Uri(String)	Initializes a new Uri object from the specified Uniform Resource Identifier (URI) string. Initializing the Uri also parses the string and populates the Uri properties that represent Uniform Resource Identifier (URI) components.

Properties

AbsoluteCanonicalUri	Gets a fully canonical RFC-compliant representation of the current URI.
AbsoluteUri	Gets the entire, non-canonical URI (It is non-canonical because it might actually be an IRI, per the Windows.Foundation.Uri encoding behavior; see Remarks.).
DisplayIri	Gets the decoded unicode characters that make up the current URI.
DisplayUri	Gets a representation of the Uniform Resource Identifier (URI) that can be used for display purposes.
Domain	Gets the domain name component, including top-level domain, from a Uniform Resource Identifier (URI).
Extension	Gets the file name extension of the resource that is referenced in the Uri.
Fragment	Gets the text following a fragment marker (#), including the fragment marker itself.
Host	Gets the fully qualified domain name.
Password	Gets the password component of the Uniform Resource Identifier (URI) as stored in this Uri instance.
Path	Gets the path and resource name component of the Uniform Resource Identifier (URI) as stored in this Uri instance.
Port	Gets the port number component of the Uniform Resource Identifier (URI) as stored in this Uri instance
Query	Gets the query string component of the Uniform Resource Identifier (URI) as stored in this Uri instance.
QueryParsed	Gets a parsed Uniform Resource Identifier (URI) query string.
RawUri	Gets the entire original Uniform Resource Identifier (URI) string as used to construct this Uri object, before parsing, and without any encoding applied.
SchemeName	Gets the protocol scheme name component of the Uniform Resource Identifier (URI) as stored in this Uri instance
Suspicious	Gets a value that indicates whether parsing determined that the Uniform Resource Identifier (URI) is not well-formed.
UserName	Gets the user name component of the Uniform Resource Identifier (URI) as stored in this Uri instance.

Methods

CombineUri(String)	Adds the specified Uniform Resource Identifier (URI) to the current Uri.
Equals(Uri)	Determines whether the specified Uri object is equal to the current Uri object.
EscapeComponent(String)	Converts a Uniform Resource Identifier (URI) string to its escaped representation.
ToString()	Gets a canonical string representation for the current Uri.
UnescapeComponent(String)	Converts the specified string by replacing any escape sequences with their unescaped representation.

See also

• WwwFormUrlDecoder
• System.Uri
• How to reference content (HTML)
• How to load file resources (XAML)
• Connecting to networks and web services
• createObjectURL (for HTML/JavaScript)
• RFC 3986
• RFC 3987
• RssReader sample