Package Package Package Package Class

Definition

Stellt einen Container dar, in dem mehrere Datenobjekte gespeichert werden können.Represents a container that can store multiple data objects.

public ref class Package abstract : IDisposable
public abstract class Package : IDisposable
type Package = class
    interface IDisposable
Public MustInherit Class Package
Implements IDisposable
Vererbung
PackagePackagePackagePackage
Abgeleitet
Implementiert

Beispiele

Das folgende Beispiel zeigt die grundlegenden Schritte zum Erstellen einer Package.The following example shows the basic steps for creating a Package. In diesem Beispiel wird ein Paket erstellt, damit ein Dokument sowie eine Grafik enthält, die als Teil des Dokuments angezeigt wird.In this example, a package is created to contain a document together with a graphic image that is displayed as part of the document. (Dies ist vergleichbar mit der Fall, in dem eine HTML-Datei hat, eine <IMG > Tag, eine externe Bilddatei verweist.) Zwei PackageRelationship Elemente sind ebenfalls im Paket enthalten.(This is similar to the case in which an HTML file has an <IMG> tag that references an external image file.) Two PackageRelationship elements are also included in the package. Die erste, eine "Beziehung auf"Paketebene, definiert den Dokumentteil als Stammelement des Pakets an.The first, a "package-level" relationship, defines the document part as the package's root element. Eine zweite Beziehung "auf" definiert die Zuordnung zwischen den Dokumentteil (die "Quelle" der Beziehung auf Teilebene) und die Verwendung des Teils Image (das "Target" der Beziehung auf Teilebene).A second, "part-level" relationship defines the association between the document part (the "source" of the part-level relationship) and its use of the image part (the "target" of the part-level relationship). Das vollständige Beispiel finden Sie unter Writing a Package Sample.For the complete sample, see Writing a Package Sample.

//  -------------------------- 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 ' 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 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 ' end:CopyStream()

Hinweise

Package ist eine abstrakte Klasse, die zum Organisieren von Objekten in einer einzelnen Entität mit einem definierten physischen Format für Portabilität und einen effizienten Zugriff verwendet werden kann.Package is an abstract class that can be used to organize objects into a single entity of a defined physical format for portability and efficient access.

Eine ZIP-Datei ist der primäre physische Format für die Package.A ZIP file is the primary physical format for the Package. Andere Package Implementierungen möglicherweise andere physikalische Formate wie z. B. ein XML-Dokument, einer Datenbank verwenden oder einen Webdienst.Other Package implementations might use other physical formats such as an XML document, a database, or Web service.

Wie ein Dateisystem, Elemente, die in enthaltenen eine Package wird in eine hierarchische Organisation von Ordnern und Dateien verwiesen.Like a file system, items contained in a Package are referenced in a hierarchical organization of folders and files.

Obwohl Package selbst ist eine abstrakte Klasse, die ZipPackage abgeleiteten Klasse wird als standardmäßig verwendet die Open Methode.Although Package itself is an abstract class, the ZipPackage derived class is used as default by the Open method.

Ein PackagePart ("Part") ist die abstrakte Klasse, die ein Objekt darstellt, die in gespeichert ist eine Package.A PackagePart ("part") is the abstract class that represents an object that is stored in a Package.

Ein PackageRelationship ("Beziehung") definiert eine Zuordnung zwischen einer Quelle Package oder PackagePart und einem Zielobjekt.A PackageRelationship ("relationship") defines an association between a source Package or PackagePart and a target object. Ein PackageRelationship kann eine von zwei Typen, von denen jede eine von zwei Formen kann:A PackageRelationship can be one of two types, each of which can be one of two forms:

  • Eine Beziehung auf Paketebene (erstellt durch die Package.CreateRelationship Methode) bezieht sich ein Package entweder:A package-level relationship (created by the Package.CreateRelationship method) relates a Package to either:

    • Ein Zielteil im Paket.A target part in the package.

    • Eine Ressource außerhalb des Pakets.A target resource outside the package.

  • Eine Beziehung auf Teilebene (erstellt durch die PackagePart.CreateRelationship Methode) bezieht sich eine Quelle PackagePart entweder:A part-level relationship (created by the PackagePart.CreateRelationship method) relates a source PackagePart to either:

    • Ein anderes Zielteil im Paket.Another target part in the package.

    • Eine Ressource außerhalb des Pakets.A target resource outside the package.

Die Beziehung der Quelle Package oder Quelle PackagePart gilt der "Besitzer" der Beziehung.The relationship's source Package or source PackagePart is considered the "owner" of the relationship. Wenn das Quellobjekt gelöscht wird, werden alle Beziehungen, die das Quellobjekt im Besitz ebenfalls gelöscht.When the source object is deleted, all the relationships owned by the source object are also deleted. Der Prozess des Erstellens oder Löschen einer Beziehung wird nicht physisch entweder am Quell- oder Zielspeicherort Objekte in keiner Weise geändert werden.The process of creating or deleting a relationship does not physically change either the source or target objects in any way.

Ein PackageDigitalSignature ("digitale Signatur") ist eine Zusammensetzung der Teile und Beziehungen, die eine digitale Signatur, die in enthaltenen darstellt eine Package.A PackageDigitalSignature ("digital signature") is a composition of parts and relationships representing a digital signature included with a Package. Die digitale Signatur vom Absender identifiziert und überprüft, dass die signierten Teile und Beziehungen in enthalten die Package nicht geändert wurde.The digital signature identifies the originator and validates that the signed parts and relationships contained in the Package have not been modified.

Pakete, unterstützen auch Verwaltung digitaler Rechte (Digital Rights Management, DRM) dadurch Inhaltselemente in einen Package mit bestimmten Zugriffsrechten auf autorisierte Benutzer verschlüsselt werden.Packages also support Digital Rights Management (DRM) which allows content elements in a Package to be encrypted with specific access rights granted to authorized users.

Basierend auf den Package Architektur eine XpsDocument ist vorgesehen, die zum Speichern von Dokumenten, die basierend auf dem offenen XML Paper Specification (XPS).Based on the Package architecture, an XpsDocument is a package type designed for storing documents based on the open XML Paper Specification (XPS).

.NET Framework verwendet Pakete zum Speichern von Inhalten, Ressourcen und Beziehungen für Seiten und Dokumente mithilfe einer standardmäßigen ZIP-Datei wird standardmäßig an.The .NET Framework uses packages to store content, resources, and relationships for pages and documents using a standard ZIP file by default. Wie bei jedem der ZIP-Datei Ihrer Anwendung die System.IO.Packaging Klassen zum Speichern und optional einem beliebigen Typ oder die Anzahl der Datendateien in einem einzelnen Container Zugriff zu schützen.As with any ZIP file, your application can use the System.IO.Packaging classes to store and optionally protect any type or number of data files in a single efficient-to-access container.

Weitere Informationen finden Sie in der Open Packaging Conventions (OPC)-Spezifikation herunterladen: https://go.microsoft.com/fwlink/?LinkID=71255.For more information, see the Open Packaging Conventions (OPC) specification available for download at https://go.microsoft.com/fwlink/?LinkID=71255.

Konstruktoren

Package(FileAccess) Package(FileAccess) Package(FileAccess) Package(FileAccess)

Initialisiert eine neue Instanz der Package-Klasse, die einen angegebenen FileAccess verwendet.Initializes a new instance of the Package class that uses a given FileAccess.

Package(FileAccess, Boolean) Package(FileAccess, Boolean) Package(FileAccess, Boolean) Package(FileAccess, Boolean)

Initialisiert eine neue Instanz der Package-Klasse, die einen angegebenen FileAccess und eine angegebene Streamingoption verwendet.Initializes a new instance of the Package class that uses a given FileAccess and streaming option.

Eigenschaften

FileOpenAccess FileOpenAccess FileOpenAccess FileOpenAccess

Ruft die Dateizugriffseinstellung für das Paket ab.Gets the file access setting for the package.

PackageProperties PackageProperties PackageProperties PackageProperties

Ruft die Haupteigenschaften des Pakets ab.Gets the core properties of the package.

Methoden

Close() Close() Close() Close()

Speichert und schließt das Paket sowie alle zugrunde liegenden Partstreams.Saves and closes the package plus all underlying part streams.

CreatePart(Uri, String) CreatePart(Uri, String) CreatePart(Uri, String) CreatePart(Uri, String)

Erstellt ein neues unkomprimiertes Part mit einem angegebenen URI und Inhaltstyp.Creates a new uncompressed part with a given URI and content type.

CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption)

Erstellt ein neues Part mit einem angegebenen URI, einem angegebenen Inhaltstyp und einer angegebenen Komprimierungsoption.Creates a new part with a given URI, content type, and compression option.

CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption)

Erstellt beim Überschreiben in einer abgeleiteten Klasse ein neues Part im Paket.When overridden in a derived class, creates a new part in the package.

CreateRelationship(Uri, TargetMode, String) CreateRelationship(Uri, TargetMode, String) CreateRelationship(Uri, TargetMode, String) CreateRelationship(Uri, TargetMode, String)

Erstellt eine Beziehung auf Paketebene zu einem Part mit einem angegebenen URI, einem angegebenen Zielmodus und einem angegebenen Beziehungstyp.Creates a package-level relationship to a part with a given URI, target mode, and relationship type.

CreateRelationship(Uri, TargetMode, String, String) CreateRelationship(Uri, TargetMode, String, String) CreateRelationship(Uri, TargetMode, String, String) CreateRelationship(Uri, TargetMode, String, String)

Erstellt eine Beziehung auf Paketebene zu einem Part mit einem angegebenen URI, einem angegebenen Zielmodus, einem angegebenen Beziehungstyp und einer angegebenen Bezeichner (identifier; ID)identifier (ID).Creates a package-level relationship to a part with a given URI, target mode, relationship type, and Bezeichner (identifier; ID)identifier (ID).

DeletePart(Uri) DeletePart(Uri) DeletePart(Uri) DeletePart(Uri)

Löscht ein Part mit einem angegebenen URI aus dem Paket.Deletes a part with a given URI from the package.

DeletePartCore(Uri) DeletePartCore(Uri) DeletePartCore(Uri) DeletePartCore(Uri)

Löscht beim Überschreiben in einer abgeleiteten Klasse ein Part mit einem angegebenen URI.When overridden in a derived class, deletes a part with a given URI.

DeleteRelationship(String) DeleteRelationship(String) DeleteRelationship(String) DeleteRelationship(String)

Löscht eine Beziehung auf Paketebene.Deletes a package-level relationship.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Leert und speichert den Inhalt von allen Parts und Beziehungen, schließt das Paket und gibt alle Ressourcen frei.Flushes and saves the content of all parts and relationships, closes the package, and releases all resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Flush() Flush() Flush() Flush()

Speichert die Inhalte von allen Parts und Beziehungen, die im Paket enthalten sind.Saves the contents of all parts and relationships that are contained in the package.

FlushCore() FlushCore() FlushCore() FlushCore()

Speichert beim Überschreiben in einer abgeleiteten Klasse die Inhalte aller Parts und Beziehungen im Speicher der abgeleiteten Klasse.When overridden in a derived class, saves the content of all parts and relationships to the derived class store.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetPart(Uri) GetPart(Uri) GetPart(Uri) GetPart(Uri)

Gibt das Part mit einem angegebenen URI zurück.Returns the part with a given URI.

GetPartCore(Uri) GetPartCore(Uri) GetPartCore(Uri) GetPartCore(Uri)

Gibt beim Überschreiben in einer abgeleiteten Klasse das von einem angegebenen URI adressierte Part zurück.When overridden in a derived class, returns the part addressed by a given URI.

GetParts() GetParts() GetParts() GetParts()

Gibt eine Auflistung aller Parts im Paket zurück.Returns a collection of all the parts in the package.

GetPartsCore() GetPartsCore() GetPartsCore() GetPartsCore()

Gibt beim Überschreiben in einer abgeleiteten Klasse ein Array aller Parts im Paket zurück.When overridden in a derived class, returns an array of all the parts in the package.

GetRelationship(String) GetRelationship(String) GetRelationship(String) GetRelationship(String)

Gibt die Beziehung auf Paketebene zu einem angegebenen Bezeichner zurück.Returns the package-level relationship with a given identifier.

GetRelationships() GetRelationships() GetRelationships() GetRelationships()

Gibt eine Auflistung aller Beziehungen auf Paketebene zurück.Returns a collection of all the package-level relationships.

GetRelationshipsByType(String) GetRelationshipsByType(String) GetRelationshipsByType(String) GetRelationshipsByType(String)

Gibt eine Auflistung aller Beziehungen auf Paketebene zurück, die mit einem angegebenen RelationshipType übereinstimmen.Returns a collection of all the package-level relationships that match a given RelationshipType.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
Open(Stream) Open(Stream) Open(Stream) Open(Stream)

Öffnet ein Paket in einem angegebenen E/A-Stream.Opens a package on a given IO stream.

Open(Stream, FileMode) Open(Stream, FileMode) Open(Stream, FileMode) Open(Stream, FileMode)

Öffnet ein Paket mit einem angegebenen E/A-Stream und Dateimodus.Opens a package with a given IO stream and file mode.

Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess)

Öffnet ein Paket mit einem angegebenen E/A-Stream, einem angegebenen Dateimodus und einer angegebenen Dateizugriffseinstellung.Opens a package with a given IO stream, file mode, and file access setting.

Open(String) Open(String) Open(String) Open(String)

Öffnet ein Paket mit einem angegebenen Pfad und Dateinamen.Opens a package at a given path and file name.

Open(String, FileMode) Open(String, FileMode) Open(String, FileMode) Open(String, FileMode)

Öffnet mithilfe einer angegebenen Dateimethode ein Paket in einem angegebenen Pfad.Opens a package at a given path using a given file mode.

Open(String, FileMode, FileAccess) Open(String, FileMode, FileAccess) Open(String, FileMode, FileAccess) Open(String, FileMode, FileAccess)

Öffnet mit einem angegebenen Dateimodus und einer angegebenen Dateizugriffseinstellung ein Paket in einem angegebenen Pfad.Opens a package at a given path using a given file mode and file access setting.

Open(String, FileMode, FileAccess, FileShare) Open(String, FileMode, FileAccess, FileShare) Open(String, FileMode, FileAccess, FileShare) Open(String, FileMode, FileAccess, FileShare)

Öffnet mit einem angegebenen Dateimodus, einer angegebenen Dateizugriffseinstellung und einer angegebenen Dateifreigabeeinstellung ein Paket in einem angegebenen Pfad.Opens a package at a given path using a given file mode, file access, and file share setting.

PartExists(Uri) PartExists(Uri) PartExists(Uri) PartExists(Uri)

Gibt an, ob ein Part mit einem angegebenen URI im Paket vorhanden ist.Indicates whether a part with a given URI is in the package.

RelationshipExists(String) RelationshipExists(String) RelationshipExists(String) RelationshipExists(String)

Gibt an, ob eine Beziehung auf Paketebene mit einer angegebenen ID im Paket enthalten ist.Indicates whether a package-level relationship with a given ID is contained in the package.

ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

Dieser Member unterstützt die Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF)-Infrastruktur und ist nicht für die Anwendungsverwendung vorgesehen.This member supports the Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF) infrastructure and is not intended for application use. Verwenden Sie stattdessen die typsichere Dispose(Boolean)-Methode.Use the type-safe Dispose(Boolean) method instead.

Gilt für:

Siehe auch