.NET Framework Class Library
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.

Inheritance Hierarchy
SystemObject
   System.IO.PackagingPackage
    System.IO.PackagingZipPackage

Namespace:   System.IO.Packaging
Assembly:  WindowsBase (in WindowsBase.dll)
Syntax
Public NotInheritable Class ZipPackage _
	Inherits [%$TOPIC/ms571948_en-us_VS_110_3_0_0_0_0%]
public sealed class ZipPackage : [%$TOPIC/ms571948_en-us_VS_110_3_0_1_0_0%]
public ref class ZipPackage sealed : public [%$TOPIC/ms571948_en-us_VS_110_3_0_2_0_0%]
[<[%$TOPIC/ms571948_en-us_VS_110_3_0_3_0_0%]>]
type ZipPackage =  
    class 
        inherit [%$TOPIC/ms571948_en-us_VS_110_3_0_3_0_1%] 
    end

The ZipPackage type exposes the following members.

Properties
  NameDescription
Public property FileOpenAccessGets the file access setting for the package. (Inherited from Package.)
Public property PackagePropertiesGets the core properties of the package. (Inherited from Package.)
Top
Methods
  NameDescription
Public method CloseSaves and closes the package plus all underlying part streams. (Inherited from Package.)
Public method CreatePart(Uri, String)Creates a new uncompressed part with a given URI and content type. (Inherited from Package.)
Public method CreatePart(Uri, String, CompressionOption)Creates a new part with a given URI, content type, and compression option. (Inherited from Package.)
Public method CreateRelationship(Uri, TargetMode, String)Creates a package-level relationship to a part with a given URI, target mode, and relationship type. (Inherited from Package.)
Public method CreateRelationship(Uri, TargetMode, String, String)Creates a package-level relationship to a part with a given URI, target mode, relationship type, and identifier (ID). (Inherited from Package.)
Public method DeletePartDeletes a part with a given URI from the package. (Inherited from Package.)
Public method DeleteRelationshipDeletes a package-level relationship. (Inherited from Package.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method FlushSaves the contents of all parts and relationships that are contained in the package. (Inherited from Package.)
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetPartReturns the part with a given URI. (Inherited from Package.)
Public method GetPartsReturns a collection of all the parts in the package. (Inherited from Package.)
Public method GetRelationshipReturns the package-level relationship with a given identifier. (Inherited from Package.)
Public method GetRelationshipsReturns a collection of all the package-level relationships. (Inherited from Package.)
Public method GetRelationshipsByTypeReturns a collection of all the package-level relationships that match a given RelationshipType. (Inherited from Package.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method PartExistsIndicates whether a part with a given URI is in the package. (Inherited from Package.)
Public method RelationshipExistsIndicates whether a package-level relationship with a given ID is contained in the package. (Inherited from Package.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IDisposableDisposeThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended for application use. Use the type-safe Dispose method instead. (Inherited from Package.)
Top
Remarks

The Package. Open method uses ZipPackage containers by default.

Examples

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 Shared Sub CreatePackage()
    ' 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))

    ' 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 As Package = Package.Open(packagePath, FileMode.Create)
        ' Add the Document part to the Package
        Dim packagePartDocument As PackagePart = package.CreatePart(partUriDocument, System.Net.Mime.MediaTypeNames.Text.Xml)

        ' Copy the data to the Document Part
        Using fileStream As New FileStream(documentPath, FileMode.Open, FileAccess.Read)
            CopyStream(fileStream, packagePartDocument.GetStream())
        End Using ' end:using(fileStream) - Close and dispose fileStream.

        ' Add a Package Relationship to the Document Part
        package.CreateRelationship(packagePartDocument.Uri, TargetMode.Internal, PackageRelationshipType)

        ' Add a Resource Part to the Package
        Dim packagePartResource As PackagePart = package.CreatePart(partUriResource, System.Net.Mime.MediaTypeNames.Image.Jpeg)

        ' Copy the data to the Resource Part
        Using fileStream As New FileStream(resourcePath, FileMode.Open, FileAccess.Read)
            CopyStream(fileStream, packagePartResource.GetStream())
        End Using ' end:using(fileStream) - Close and dispose fileStream.

        ' Add Relationship from the Document part to the Resource part
        packagePartDocument.CreateRelationship(New Uri("../resources/image1.jpg", UriKind.Relative), TargetMode.Internal, ResourceRelationshipType)

    End Using ' end:using (Package package) - Close and dispose package.

End Sub ' end:CreatePackage()
//  -------------------------- 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 =
            package.CreatePart(partUriDocument,
                           System.Net.Mime.MediaTypeNames.Text.Xml);

        // 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
        package.CreateRelationship(packagePartDocument.Uri,
                                   TargetMode.Internal,
                                   PackageRelationshipType);

        // Add a Resource Part to the Package
        PackagePart packagePartResource =
            package.CreatePart(partUriResource,
                           System.Net.Mime.MediaTypeNames.Image.Jpeg);

        // 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
        packagePartDocument.CreateRelationship(
                                new Uri(@"../resources/image1.jpg",
                                UriKind.Relative),
                                TargetMode.Internal,
                                ResourceRelationshipType);

    }// 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.

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows Phone 8.1, Windows Phone 8, 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.

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