PackUriHelper.Create 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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a new pack URI.

Overloads

Create(Uri)	Creates a new pack URI that points to a package.
Create(Uri, Uri)	Creates a pack URI given a Package URI and the URI of a part in the package.
Create(Uri, Uri, String)	Creates a pack URI given a Package URI, the URI of a part in the package, and a "#" fragment to append.

Remarks

The following table illustrates sample cases for the Create method.

`packageUri`	`partUri`	`fragment`	Returned pack URI
`http://www.proseware.com/mypackage.pkg`	/page1.xaml	#intro	pack://http:,,www.proseware.com,mypackage.pkg/page1.xaml#intro
`http://www.proseware.com/mypackage.pkg`	/page2.xaml	null	pack://http:,,www.proseware.com,mypackage.pkg/page2.xaml
`http://www.proseware.com/mypackage.pkg`	/a/page4.xaml	null	pack://http:,,www.proseware.com,mypackage.pkg/a/page4.xaml
`http://www.proseware.com/mypackage.pkg`	/%41/%61.xml	null	pack://http:,,www.proseware.com,mypackage.pkg/A/a.xml
`http://www.proseware.com/mypackage.pkg`	/%25XY.xml	null	pack://http:,,www.proseware.com,mypackage.pkg/%25XY.xml
`http://www.proseware.com/mypackage.pkg`	/a/page5.xaml	#summary	pack://http:,,www.proseware.com,mypackage.pkg/a/page5.xaml#summary
`http://www.proseware.com/packages.aspx?pkg04`	/page1.xaml	#intro	pack://http:,,www.proseware.com,packages.aspx%3fpkg04/page1.xaml#intro
`http://www.proseware.com/mypackage.pkg`	null	null	pack://http:,,www.proseware.com,mypackage.pkg
`ftp://ftp.proseware.com/packages/mypackage1.abc`	/a/mydoc.xaml	null	pack://ftp:,,ftp.proseware.com,packages,mypackage1.abc/a/mydoc.xaml
`file:///d:/packages/mypackage2.pkg`	/a/bar.xaml	#xref	pack://file:,,,d:,packages,mypackage2.pkg/a/bar.xaml#xref

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.

Create(Uri)

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Creates a new pack URI that points to a package.

public:
 static Uri ^ Create(Uri ^ packageUri);

public static Uri Create (Uri packageUri);

static member Create : Uri -> Uri

Public Shared Function Create (packageUri As Uri) As Uri

Parameters

packageUri: Uri

The URI of the referenced Package.

Returns

Uri

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

Exceptions

ArgumentNullException

packageUri is null.

ArgumentException

packageUri is not an absolute URI.

Examples

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);

    // Retrieve 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()

' ------------------------ 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 Function GetFixedDocument(ByVal fixedDocUri As Uri) As FixedDocument
    Dim fixedDocument As FixedDocument = Nothing

    ' 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.
    Dim tempUri As New Uri(_xpsDocumentPath, UriKind.RelativeOrAbsolute)
    Dim parserContext As New ParserContext()
    parserContext.BaseUri = PackUriHelper.Create(tempUri)

    ' Retrieve the fixed document.
    Dim fixedDocPart As PackagePart = _xpsPackage.GetPart(fixedDocUri)
    If fixedDocPart IsNot Nothing Then
        Dim fixedObject As Object = XamlReader.Load(fixedDocPart.GetStream(), parserContext)
        If fixedObject IsNot Nothing Then
            fixedDocument = TryCast(fixedObject, FixedDocument)
        End If
    End If

    Return fixedDocument
End Function ' end:GetFixedDocument()

Remarks

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 (,).

Applies to

Create(Uri, Uri)

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Creates a pack URI given a Package URI and the URI of a part in the package.

public:
 static Uri ^ Create(Uri ^ packageUri, Uri ^ partUri);

public static Uri Create (Uri packageUri, Uri? partUri);

public static Uri Create (Uri packageUri, Uri partUri);

static member Create : Uri * Uri -> Uri

Public Shared Function Create (packageUri As Uri, partUri As Uri) As Uri

Parameters

packageUri: Uri

The URI of the Package.

partUri: Uri

The URI of the PackagePart in the package.

Returns

Uri

The pack URI of the given PackagePart.

Exceptions

ArgumentNullException

packageUri is null.

ArgumentException

packageUri is not an absolute URI.

-or-

partUri is not a valid part URI syntax.

Examples

The following example shows how to use the Create(Uri) 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);

    // Retrieve 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()

' ------------------------ 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 Function GetFixedDocument(ByVal fixedDocUri As Uri) As FixedDocument
    Dim fixedDocument As FixedDocument = Nothing

    ' 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.
    Dim tempUri As New Uri(_xpsDocumentPath, UriKind.RelativeOrAbsolute)
    Dim parserContext As New ParserContext()
    parserContext.BaseUri = PackUriHelper.Create(tempUri)

    ' Retrieve the fixed document.
    Dim fixedDocPart As PackagePart = _xpsPackage.GetPart(fixedDocUri)
    If fixedDocPart IsNot Nothing Then
        Dim fixedObject As Object = XamlReader.Load(fixedDocPart.GetStream(), parserContext)
        If fixedObject IsNot Nothing Then
            fixedDocument = TryCast(fixedObject, FixedDocument)
        End If
    End If

    Return fixedDocument
End Function ' end:GetFixedDocument()

Remarks

packageUri may not be specified as null or empty.

If partUri is null, the returned pack URI points to the package.

The following table illustrates sample cases for the Create method.

`packageUri`	`partUri`	Returned pack URI
`http://www.proseware.com/mypackage.pkg`	/page2.xaml	pack://http:,,www.proseware.com,mypackage.pkg/page2.xaml
`http://www.proseware.com/mypackage.pkg`	/a/page4.xaml	pack://http:,,www.proseware.com,mypackage.pkg/a/page4.xaml
`http://www.proseware.com/mypackage.pkg`	/%41/%61.xml	pack://http:,,www.proseware.com,mypackage.pkg/A/a.xml
`http://www.proseware.com/mypackage.pkg`	/%25XY.xml	pack://http:,,www.proseware.com,mypackage.pkg/%25XY.xml
`http://www.proseware.com/mypackage.pkg`	null	pack://http:,,www.proseware.com,mypackage.pkg
ftp://ftp.proseware.com/packages/mypackage1.abc	/a/mydoc.xaml	pack://ftp:,,ftp.proseware.com,packages,mypackage1.abc/a/mydoc.xaml
file:///d:/packages/mypackage2.pkg	/a/bar.xaml	pack://file:,,,d:,packages,mypackage2.pkg/a/bar.xaml

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 (,).

Applies to

Create(Uri, Uri, String)

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Source:: PackUriHelper.PackUriScheme.cs

Creates a pack URI given a Package URI, the URI of a part in the package, and a "#" fragment to append.

public:
 static Uri ^ Create(Uri ^ packageUri, Uri ^ partUri, System::String ^ fragment);

public static Uri Create (Uri packageUri, Uri? partUri, string? fragment);

public static Uri Create (Uri packageUri, Uri partUri, string fragment);

static member Create : Uri * Uri * string -> Uri

Public Shared Function Create (packageUri As Uri, partUri As Uri, fragment As String) As Uri

Parameters

packageUri: Uri

The URI of the Package.

partUri: Uri

The URI of the PackagePart in the package.

fragment: String

A "#" reference identifying an element within the package part.

Returns

Uri

The pack URI that identifies the specified package, package part, and fragment.

Exceptions

ArgumentNullException

packageUri is null.

ArgumentException

packageUri is not an absolute URI.

-or-

partUri is not a valid part URI syntax.

-or-

fragment is empty or does begin with "#".

Examples

The following example shows how to use the Create(Uri) 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);

    // Retrieve 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()

' ------------------------ 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 Function GetFixedDocument(ByVal fixedDocUri As Uri) As FixedDocument
    Dim fixedDocument As FixedDocument = Nothing

    ' 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.
    Dim tempUri As New Uri(_xpsDocumentPath, UriKind.RelativeOrAbsolute)
    Dim parserContext As New ParserContext()
    parserContext.BaseUri = PackUriHelper.Create(tempUri)

    ' Retrieve the fixed document.
    Dim fixedDocPart As PackagePart = _xpsPackage.GetPart(fixedDocUri)
    If fixedDocPart IsNot Nothing Then
        Dim fixedObject As Object = XamlReader.Load(fixedDocPart.GetStream(), parserContext)
        If fixedObject IsNot Nothing Then
            fixedDocument = TryCast(fixedObject, FixedDocument)
        End If
    End If

    Return fixedDocument
End Function ' end:GetFixedDocument()

Remarks

packageUri may not be specified as null or empty.

If partUri is null, the returned pack URI points to the package.

fragment cannot be an empty string but can be specified as null. When not specified as null, the fragment string must begin with a '#' character. For more information of the syntax of fragment references, see Section 3.5 "Fragment" of RFC 3986.

The following table illustrates sample cases for the Create method.

`packageUri`	`partUri`	`fragment`	Returned pack URI
`http://www.proseware.com/mypackage.pkg`	/page1.xaml	#intro	pack://http:,,www.proseware.com,mypackage.pkg/page1.xaml#intro
`http://www.proseware.com/mypackage.pkg`	/page2.xaml	null	pack://http:,,www.proseware.com,mypackage.pkg/page2.xaml
`http://www.proseware.com/mypackage.pkg`	/a/page4.xaml	null	pack://http:,,www.proseware.com,mypackage.pkg/a/page4.xaml
`http://www.proseware.com/mypackage.pkg`	/%41/%61.xml	null	pack://http:,,www.proseware.com,mypackage.pkg/A/a.xml
`http://www.proseware.com/mypackage.pkg`	/%25XY.xml	null	pack://http:,,www.proseware.com,mypackage.pkg/%25XY.xml
`http://www.proseware.com/mypackage.pkg`	/a/page5.xaml	#summary	pack://http:,,www.proseware.com,mypackage.pkg/a/page5.xaml#summary
`http://www.proseware.com/packages.aspx?pkg04`	/page1.xaml	#intro	pack://http:,,www.proseware.com,packages.aspx%3fpkg04/page1.xaml#intro
`http://www.proseware.com/mypackage.pkg`	null	null	pack://http:,,www.proseware.com,mypackage.pkg
`ftp://ftp.proseware.com/packages/mypackage1.abc`	/a/mydoc.xaml	null	pack://ftp:,,ftp.proseware.com,packages,mypackage1.abc/a/mydoc.xaml
`file:///d:/packages/mypackage2.pkg`	/a/bar.xaml	#xref	pack://file:,,,d:,packages,mypackage2.pkg/a/bar.xaml#xref

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 (,).

Applies to

Delen via

PackUriHelper.Create Method

Definition

Overloads

Remarks

Create(Uri)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

Create(Uri, Uri)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

Create(Uri, Uri, String)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

Aanvullende resources