Edit

Share via

PackUriHelper.CreatePartUri(Uri) Method

  • Reference

Definition

Namespace:
System.IO.Packaging
Assembly:
System.IO.Packaging.dll
Assembly:
WindowsBase.dll
Package:
System.IO.Packaging v8.0.1
Package:
System.IO.Packaging v9.0.0-rc.2.24473.5
Source:
PackUriHelper.cs
Source:
PackUriHelper.cs
Source:
PackUriHelper.cs
Source:
PackUriHelper.cs
Source:
PackUriHelper.cs

Creates a formatted PackagePart URI.

public:
 static Uri ^ CreatePartUri(Uri ^ partUri);
public static Uri CreatePartUri (Uri partUri);
static member CreatePartUri : Uri -> Uri
Public Shared Function CreatePartUri (partUri As Uri) As Uri

Parameters

partUri
Uri

The URI of the PackagePart within the package.

Returns

Uri

A formatted PackagePart URI.

Exceptions

ArgumentNullException

partUri is null.

ArgumentException

partUri is not an absolute Uri.

Examples

The following example shows how to use the CreatePartUri method to define relative URIs for PackagePart elements.

// Convert system path and file names to Part URIs. In this example
// Uri partUriDocument /* /Content/Document.xml */ =
//     PackUriHelper.CreatePartUri(
//         new Uri("Content\Document.xml", UriKind.Relative));
// Uri partUriResource /* /Resources/Image1.jpg */ =
//     PackUriHelper.CreatePartUri(
//         new Uri("Resources\Image1.jpg", UriKind.Relative));
Uri partUriDocument = PackUriHelper.CreatePartUri(
                          new Uri(documentPath, UriKind.Relative));
Uri partUriResource = PackUriHelper.CreatePartUri(
                          new Uri(resourcePath, UriKind.Relative));

' Convert system path and file names to Part URIs. In this example
' Dim partUriDocument as Uri /* /Content/Document.xml */ =
'     PackUriHelper.CreatePartUri(
'         New Uri("Content\Document.xml", UriKind.Relative))
' Dim partUriResource as Uri /* /Resources/Image1.jpg */ =
'     PackUriHelper.CreatePartUri(
'         New Uri("Resources\Image1.jpg", UriKind.Relative))
Dim partUriDocument As Uri = PackUriHelper.CreatePartUri(New Uri(documentPath, UriKind.Relative))
Dim partUriResource As Uri = PackUriHelper.CreatePartUri(New Uri(resourcePath, UriKind.Relative))

Remarks

The URI of a PackagePart is always referenced from the Package root.

The returned PackagePart URI is an absolute path that always starts with "/" and conforms to the syntax defined in the Open Packaging Conventions Specification.

The following table illustrates sample cases for CreatePartUri.

partUri Returned Part URI
picture1.jpg /picture1.jpg
/picture2.jpg /picture2.jpg
a/mydoc.xaml /a/mydoc.xaml
/b/bar.xaml /b/bar.xaml

Applies to

See also