This documentation is archived and is not being maintained.

ZipPackage Class

Implements a derived subclass of the abstract Package base class—the ZipPackage class uses a ZIP archive as the container store. This class cannot be inherited.

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

public sealed class ZipPackage : Package
You cannot directly create an instance of this class in XAML.

The Package.Open method uses ZipPackage containers by default.

This example shows how to create a basic ZipPackage.

The example creates a package that contains a single document part which is defined as the package's root element by a package-level PackageRelationship.

The package also contains an image part and a second PackageRelationship which defines an association between the source document part and the target image part. (The image is a resource that is used with the document).

//  -------------------------- CreatePackage -------------------------- 
/// <summary> 
///   Creates a package zip file containing specified 
///   content and resource files.</summary> 
private static void CreatePackage()
    // 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));

    // Create the Package 
    // (If the package file already exists, FileMode.Create will 
    //  automatically delete it first before creating a new one. 
    //  The 'using' statement insures that 'package' is 
    //  closed and disposed when it goes out of scope.) 
    using (Package package =
        Package.Open(packagePath, FileMode.Create))
        // Add the Document part to the Package
        PackagePart packagePartDocument =

        // Copy the data to the Document Part 
        using (FileStream fileStream = new FileStream(
               documentPath, FileMode.Open, FileAccess.Read))
            CopyStream(fileStream, packagePartDocument.GetStream());
        }// end:using(fileStream) - Close and dispose fileStream. 

        // Add a Package Relationship to the Document Part

        // Add a Resource Part to the Package
        PackagePart packagePartResource =

        // Copy the data to the Resource Part 
        using (FileStream fileStream = new FileStream(
               resourcePath, FileMode.Open, FileAccess.Read))
            CopyStream(fileStream, packagePartResource.GetStream());
        }// end:using(fileStream) - Close and dispose fileStream. 

        // Add Relationship from the Document part to the Resource part
                                new Uri(@"../resources/image1.jpg",

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

}// end:CreatePackage() 

//  --------------------------- CopyStream --------------------------- 
/// <summary> 
///   Copies data from a source stream to a target stream.</summary> 
/// <param name="source">
///   The source stream to copy from.</param> 
/// <param name="target">
///   The destination stream to copy to.</param> 
private static void CopyStream(Stream source, Stream target)
    const int bufSize = 0x1000;
    byte[] buf = new byte[bufSize];
    int bytesRead = 0;
    while ((bytesRead = source.Read(buf, 0, bufSize)) > 0)
        target.Write(buf, 0, bytesRead);
}// end:CopyStream()

For the complete sample, see Writing a Package Sample.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0