PackUriHelper.Create Method (Uri)

 

Creates a new pack URI that points to a package.

Namespace:   System.IO.Packaging
Assembly:  WindowsBase (in WindowsBase.dll)

public static Uri Create(
	Uri packageUri
)

Parameters

packageUri
Type: System.Uri

The URI of the referenced Package.

Return Value

Type: System.Uri

The pack URI for the Package referenced by the given packageUri.

Exception Condition
ArgumentNullException

packageUri is null.

ArgumentException

packageUri is not an absolute URI.

packageUri may not be specified as null or empty.

The following table illustrates sample cases for Create.

 packageUri

 Returned pack URI

 http://www.proseware.com/mypackage.pkg 

 pack://http:,,www.proseware.com,mypackage.pkg 

 ftp://ftp.proseware.com/packages/mypackage1.abc 

 pack://ftp:,,ftp.proseware.com,packages,mypackage1.abc 

 file:///d:/packages/mypackage2.pkg 

 pack://file:,,,d:,packages,mypackage2.pkg 

Composing a pack URI is a multi-step process. For example, one step in forming a pack URI is to replace the forward slash (/) characters of the packageUri with commas (,).

For more information on string conversion and how pack URIs are formed, see Appendix A.4 "String Conversion Examples" and Appendix B.3 "Composing a Pack URI" in the Open Packaging Conventions specification available for download at Specifications and License Downloads.

The following example shows how to use the Create method to define a pack URI that references a package.

// ------------------------ GetFixedDocument --------------------------
/// <summary>
///   Returns the fixed document at a given URI within
///   the currently open XPS package.</summary>
/// <param name="fixedDocUri">
///   The URI of the fixed document to return.</param>
/// <returns>
///   The fixed document at a given URI
///   within the current XPS package.</returns>
private FixedDocument GetFixedDocument(Uri fixedDocUri)
{
    FixedDocument fixedDocument = null;

    // Create the URI for the fixed document within the package. The URI
    // is used to set the Parser context so fonts & other items can load.
    Uri tempUri = new Uri(_xpsDocumentPath, UriKind.RelativeOrAbsolute);
    ParserContext parserContext = new ParserContext();
    parserContext.BaseUri = PackUriHelper.Create(tempUri);

    // Retreive the fixed document.
    PackagePart fixedDocPart = _xpsPackage.GetPart(fixedDocUri);
    if (fixedDocPart != null)
    {
        object fixedObject =
            XamlReader.Load(fixedDocPart.GetStream(), parserContext);
        if (fixedObject != null)
            fixedDocument = fixedObject as FixedDocument;
    }

    return fixedDocument;
}// end:GetFixedDocument()

.NET Framework
Available since 3.0
Return to top
Show: