ZipPackage Classe

Définition

Espace de noms:

System.IO.Packaging

Assembly:

System.IO.Packaging.dll

Paquet:

System.IO.Packaging v8.0.0

Source:

ZipPackage.cs

Implémente une sous-classe dérivée de la classe de base Package abstraite. La classe ZipPackage utilise un fichier d’archives .zip comme magasin conteneur. Cette classe ne peut pas être héritée.

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

Héritage

Object

Package

ZipPackage

Exemples

Cet exemple montre comment créer un base ZipPackage.

L’exemple crée un package qui contient un seul composant de document qui est défini en tant qu’élément racine du package par un package au niveau PackageRelationshipdu package.

Le package contient également une partie image et une seconde PackageRelationship qui définit une association entre le composant document source et le composant image cible. (L’image est une ressource utilisée avec le 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

Pour obtenir l’exemple complet, consultez Écriture d’un exemple de package.

Remarques

Package.Open la méthode utilise ZipPackage des conteneurs par défaut.

Propriétés

FileOpenAccess	Obtient le paramètre d'accès au fichier pour le package. (Hérité de Package)
PackageProperties	Obtient les propriétés principales du package. (Hérité de Package)

Méthodes

Close()	Enregistre et ferme le package ainsi que tout flux sous-jacent des composants. (Hérité de Package)
CreatePart(Uri, String)	Crée un nouveau composant non compressé avec un URI et un type de contenu donnés. (Hérité de Package)
CreatePart(Uri, String, CompressionOption)	Crée un nouveau composant avec un URI, un type de contenu et une option de compression donnés. (Hérité de Package)
CreatePartCore(Uri, String, CompressionOption)	En cas de substitution dans une classe dérivée, crée un nouveau composant dans le package. (Hérité de Package)
CreateRelationship(Uri, TargetMode, String)	Crée une relation au niveau du package avec un composant avec URI, mode cible et type de relation donnés. (Hérité de Package)
CreateRelationship(Uri, TargetMode, String, String)	Crée une relation au niveau du package à une partie avec un URI, un mode cible, un type de relation et un identificateur (ID) donnés. (Hérité de Package)
DeletePart(Uri)	Supprime du package un composant avec un URI donné. (Hérité de Package)
DeletePartCore(Uri)	En cas de substitution dans une classe dérivée, supprime un composant avec un URI donné. (Hérité de Package)
DeleteRelationship(String)	Supprime une relation au niveau du package. (Hérité de Package)
Dispose(Boolean)	Vide et enregistre le contenu de tous les composants et relations, ferme le package et libère toutes les ressources. (Hérité de Package)
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
Flush()	Enregistre le contenu de tous les composants et relations contenus dans le package. (Hérité de Package)
FlushCore()	En cas de substitution dans une classe dérivée, enregistre le contenu de tous les composants et relations dans le magasin de classes dérivées. (Hérité de Package)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetPart(Uri)	Retourne le composant avec un URI donné. (Hérité de Package)
GetPartCore(Uri)	En cas de substitution dans une classe dérivée, retourne le composant adressé par un URI donné. (Hérité de Package)
GetParts()	Retourne une collection de tous les composants dans le package. (Hérité de Package)
GetPartsCore()	Lors d'une substitution dans une classe dérivée, retourne un tableau contenant tous les composants dans le package. (Hérité de Package)
GetRelationship(String)	Retourne la relation au niveau du package avec un identificateur donné. (Hérité de Package)
GetRelationships()	Retourne une collection de toutes les relations au niveau du package. (Hérité de Package)
GetRelationshipsByType(String)	Retourne une collection de toutes les relations au niveau du package correspondant à un RelationshipType donné. (Hérité de Package)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
PartExists(Uri)	Indique si un composant avec un URI donné est dans le package. (Hérité de Package)
RelationshipExists(String)	Indique si une relation au niveau du package avec un ID donné est contenue dans le package. (Hérité de Package)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

IDisposable.Dispose()

Ce membre prend en charge l’infrastructure Windows Presentation Foundation (WPF) et n’est pas destiné à une utilisation de l’application. Utilisez plutôt la méthode de type sécurisé Dispose(Boolean). (Hérité de Package)

Voir aussi

• PackagePart
• Exemple d’écriture d’un package
• Exemple de lecture d’un package