Export (0) Print
Expand All

Package.GetPart Method

Returns the part with a given URI.

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

public PackagePart GetPart(
	Uri partUri
)

Parameters

partUri
Type: System.Uri

The uniform resource identifier (URI) of the part to return.

Return Value

Type: System.IO.Packaging.PackagePart
The part with the specified partUri.

ExceptionCondition
ArgumentNullException

partUri is null.

ArgumentException

partUri is not a valid PackagePart uniform resource identifier (URI).

InvalidOperationException

A part with the specified partUri is not in the package.

ObjectDisposedException

The package is not open (Dispose or Close has been called).

IOException

The package is write-only.

An InvalidOperationException is thrown if a part with the specified partUri does not exist.

The PartExists method can be used to determine whether partUri references an existing part.

By default, a ZipPackage derived implementation of the abstract Package base class is provided and used. In the default operation, GetPart internally calls GetPartCore of the ZipPackage class to return a requested part from a ZIP file.

For additional information, see the Open Packaging Conventions (OPC) specification available for download at http://go.microsoft.com/fwlink/?LinkID=71255.

Notes to Inheritors

GetPart internally calls the derived class GetPartCore method to actually flush the part based on the physical format implemented in the derived class.

The following example shows how to locate, retrieve, and read parts that are contained in a package. For the complete sample, see Reading a Package Sample.

// Open the Package. 
// ('using' statement insures that 'package' is 
//  closed and disposed when it goes out of scope.) 
using (Package package =
    Package.Open(packagePath, FileMode.Open, FileAccess.Read))
{
    PackagePart documentPart = null;
    PackagePart resourcePart = null;

    // Get the Package Relationships and look for 
    //   the Document part based on the RelationshipType
    Uri uriDocumentTarget = null;
    foreach (PackageRelationship relationship in
        package.GetRelationshipsByType(PackageRelationshipType))
    {
        // Resolve the Relationship Target Uri 
        //   so the Document Part can be retrieved.
        uriDocumentTarget = PackUriHelper.ResolvePartUri(
            new Uri("/", UriKind.Relative), relationship.TargetUri);

        // Open the Document Part, write the contents to a file.
        documentPart = package.GetPart(uriDocumentTarget);
        ExtractPart(documentPart, targetDirectory);
    }

    // Get the Document part's Relationships, 
    //   and look for required resources.
    Uri uriResourceTarget = null;
    foreach (PackageRelationship relationship in
        documentPart.GetRelationshipsByType(
                                ResourceRelationshipType))
    {
        // Resolve the Relationship Target Uri 
        //   so the Resource Part can be retrieved.
        uriResourceTarget = PackUriHelper.ResolvePartUri(
            documentPart.Uri, relationship.TargetUri);

        // Open the Resource Part and write the contents to a file.
        resourcePart = package.GetPart(uriResourceTarget);
        ExtractPart(resourcePart, targetDirectory);
    }

}// end:using(Package package) - Close & dispose package.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft