ZipPackage Class

Definition

public ref class ZipPackage sealed : System::IO::Packaging::Package

public sealed class ZipPackage : System.IO.Packaging.Package

type ZipPackage = class
 inherit Package

Public NotInheritable Class ZipPackage
Inherits Package

Inheritance

Object

Package

ZipPackage

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 that 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 =
 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()

' -------------------------- 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


' --------------------------- 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 Shared Sub CopyStream(ByVal source As Stream, ByVal target As Stream)
 Const bufSize As Integer = &H1000
 Dim buf(bufSize - 1) As Byte
 Dim bytesRead As Integer = 0
 bytesRead = source.Read(buf, 0, bufSize)
 Do While bytesRead > 0
 target.Write(buf, 0, bytesRead)
 bytesRead = source.Read(buf, 0, bufSize)
 Loop
End Sub

Remarks

The Package.Open method uses ZipPackage containers by default.

See also

• PackagePart