Package Clase

Definición

Representa un contenedor que puede almacenar varios objetos de datos.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
Herencia
Package
Derivado
Implementaciones

Ejemplos

En el ejemplo siguiente se muestran los pasos básicos para crear una Package.The following example shows the basic steps for creating a Package. En este ejemplo, se crea un paquete para que contenga un documento junto con una imagen gráfica que se muestra como parte del documento.In this example, a package is created to contain a document together with a graphic image that is displayed as part of the document. (Esto es similar al caso en el que un archivo HTML tiene una etiqueta <IMG > que hace referencia a un archivo de imagen externo). También se incluyen dos elementos PackageRelationship en el paquete.(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. La primera, una relación de "nivel de paquete", define la parte de documento como el elemento raíz del paquete.The first, a "package-level" relationship, defines the document part as the package's root element. En segundo lugar, la relación de "nivel de elemento" define la asociación entre la parte de documento (el "origen" de la relación de nivel de elemento) y su uso de la parte de imagen (el "destino" de la relación de nivel de elemento).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). Para obtener el ejemplo completo, consulte escribir un ejemplo de paquete.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


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

Comentarios

Package es una clase abstracta que se puede utilizar para organizar los objetos en una sola entidad de un formato físico definido para la portabilidad y el acceso eficaz.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.

Un archivo ZIP es el formato físico principal del Package.A ZIP file is the primary physical format for the Package. Otras implementaciones de Package podrían usar otros formatos físicos, como un documento XML, una base de datos o un servicio Web.Other Package implementations might use other physical formats such as an XML document, a database, or Web service.

Al igual que un sistema de archivos, se hace referencia a los elementos contenidos en una Package en una organización jerárquica de carpetas y archivos.Like a file system, items contained in a Package are referenced in a hierarchical organization of folders and files.

Aunque Package misma es una clase abstracta, el método Open utiliza la clase derivada ZipPackage como valor predeterminado.Although Package itself is an abstract class, the ZipPackage derived class is used as default by the Open method.

Una PackagePart ("parte") es la clase abstracta que representa un objeto que se almacena en un Package.A PackagePart ("part") is the abstract class that represents an object that is stored in a Package.

Un PackageRelationship ("relación") define una asociación entre un Package de origen o PackagePart y un objeto de destino.A PackageRelationship ("relationship") defines an association between a source Package or PackagePart and a target object. Un PackageRelationship puede ser uno de dos tipos, cada uno de los cuales puede tener una de estas dos formas:A PackageRelationship can be one of two types, each of which can be one of two forms:

  • Una relación de nivel de paquete (creada por el método Package.CreateRelationship) relaciona un Package con:A package-level relationship (created by the Package.CreateRelationship method) relates a Package to either:

    • Una parte de destino en el paquete.A target part in the package.

    • Un recurso de destino fuera del paquete.A target resource outside the package.

  • Una relación de nivel de elemento (creada por el método PackagePart.CreateRelationship) relaciona un PackagePart de origen con:A part-level relationship (created by the PackagePart.CreateRelationship method) relates a source PackagePart to either:

    • Otra parte de destino del paquete.Another target part in the package.

    • Un recurso de destino fuera del paquete.A target resource outside the package.

La PackagePart de origen Package o de origen de la relación se considera el "propietario" de la relación.The relationship's source Package or source PackagePart is considered the "owner" of the relationship. Cuando se elimina el objeto de origen, también se eliminan todas las relaciones propiedad del objeto de origen.When the source object is deleted, all the relationships owned by the source object are also deleted. El proceso de creación o eliminación de una relación no cambia físicamente los objetos de origen o de destino de ninguna manera.The process of creating or deleting a relationship does not physically change either the source or target objects in any way.

Un PackageDigitalSignature ("firma digital") es una composición de partes y relaciones que representan una firma digital incluida en un Package.A PackageDigitalSignature ("digital signature") is a composition of parts and relationships representing a digital signature included with a Package. La firma digital identifica el originador y valida que no se han modificado los elementos y las relaciones firmados contenidos en el Package.The digital signature identifies the originator and validates that the signed parts and relationships contained in the Package have not been modified.

Los paquetes también admiten Rights Management digitales (DRM), lo que permite que los elementos de contenido de un Package se cifren con derechos de acceso específicos concedidos a usuarios autorizados.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.

En función de la arquitectura de Package, un XpsDocument es un tipo de paquete diseñado para almacenar documentos basados en XML Paper Specification (XPS)abierto.Based on the Package architecture, an XpsDocument is a package type designed for storing documents based on the open XML Paper Specification (XPS).

El .NET Framework usa paquetes para almacenar el contenido, los recursos y las relaciones de páginas y documentos mediante un archivo ZIP estándar de forma predeterminada.The .NET Framework uses packages to store content, resources, and relationships for pages and documents using a standard ZIP file by default. Como con cualquier archivo ZIP, la aplicación puede usar las clases de System.IO.Packaging para almacenar y, opcionalmente, proteger cualquier tipo o número de archivos de datos en un único contenedor de acceso eficaz.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.

Para obtener más información, vea la especificación de convenciones de empaquetado abierto (OPC) disponible para su descarga en 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.

Constructores

Package(FileAccess)

Inicializa una nueva instancia de la clase Package con FileAccess especificada.Initializes a new instance of the Package class that uses a given FileAccess.

Package(FileAccess, Boolean)

Inicializa una nueva instancia de la clase Package con una FileAccess y una opción de transmisión por secuencias especificadas.Initializes a new instance of the Package class that uses a given FileAccess and streaming option.

Propiedades

FileOpenAccess

Obtiene la configuración de acceso de archivos del paquete.Gets the file access setting for the package.

PackageProperties

Obtiene las propiedades básicas del paquete.Gets the core properties of the package.

Métodos

Close()

Guarda y cierra el paquete más todas las secuencias de los elementos subyacentes.Saves and closes the package plus all underlying part streams.

CreatePart(Uri, String)

Crea un nuevo elemento sin comprimir con un URI y el tipo de contenido especificados.Creates a new uncompressed part with a given URI and content type.

CreatePart(Uri, String, CompressionOption)

Crea un nuevo elemento con un URI, tipo de contenido y opción de compresión especificados.Creates a new part with a given URI, content type, and compression option.

CreatePartCore(Uri, String, CompressionOption)

Cuando se invalida en una clase derivada, crea un nuevo elemento en el paquete.When overridden in a derived class, creates a new part in the package.

CreateRelationship(Uri, TargetMode, String)

Crea una relación de nivel de paquete en un elemento con un URI, modo de destino y tipo de relación especificados.Creates a package-level relationship to a part with a given URI, target mode, and relationship type.

CreateRelationship(Uri, TargetMode, String, String)

Crea una relación de nivel de paquete en un elemento con un URI, modo de destino, tipo de relación y identificador (id.)identifier (ID) especificados.Creates a package-level relationship to a part with a given URI, target mode, relationship type, and identificador (id.)identifier (ID).

DeletePart(Uri)

Elimina un elemento con un URI especificado desde el paquete.Deletes a part with a given URI from the package.

DeletePartCore(Uri)

Cuando se invalida en una clase derivada, elimina un elemento con un URI especificado.When overridden in a derived class, deletes a part with a given URI.

DeleteRelationship(String)

Elimina una relación de nivel del paquete.Deletes a package-level relationship.

Dispose(Boolean)

Vacía y guarda el contenido de todos los elementos y relaciones, cierra el paquete y libera todos los recursos.Flushes and saves the content of all parts and relationships, closes the package, and releases all resources.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
Flush()

Guarda el contenido de todos los elementos y relaciones contenidos en el paquete.Saves the contents of all parts and relationships that are contained in the package.

FlushCore()

Cuando se invalida en una clase derivada, guarda el contenido de todos los elementos y relaciones en el almacén de la clase derivada.When overridden in a derived class, saves the content of all parts and relationships to the derived class store.

GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetPart(Uri)

Devuelve el elemento con un URI especificado.Returns the part with a given URI.

GetPartCore(Uri)

Cuando se invalida en una clase derivada, devuelve el elemento tratado por un URI especificado.When overridden in a derived class, returns the part addressed by a given URI.

GetParts()

Devuelve una colección de todos los elementos en el paquete.Returns a collection of all the parts in the package.

GetPartsCore()

Cuando se invalida en una clase derivada, devuelve una matriz de todos los elementos del paquete.When overridden in a derived class, returns an array of all the parts in the package.

GetRelationship(String)

Devuelve la relación de nivel de paquete con un identificador especificado.Returns the package-level relationship with a given identifier.

GetRelationships()

Devuelve una colección de todas las relaciones de nivel de paquete.Returns a collection of all the package-level relationships.

GetRelationshipsByType(String)

Devuelve una colección de todas las relaciones de nivel de paquete que coincidan con una propiedad RelationshipType especificada.Returns a collection of all the package-level relationships that match a given RelationshipType.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
Open(Stream)

Abre un paquete en una secuencia de E/S especificada.Opens a package on a given IO stream.

Open(Stream, FileMode)

Abre un paquete con una secuencia de E/S y un modo de archivo especificados.Opens a package with a given IO stream and file mode.

Open(Stream, FileMode, FileAccess)

Abre un paquete con una secuencia de E/S, un modo de archivo y la configuración de acceso de archivo especificados.Opens a package with a given IO stream, file mode, and file access setting.

Open(String)

Abre un paquete en una ruta de acceso y un nombre de archivo especificados.Opens a package at a given path and file name.

Open(String, FileMode)

Abre un paquete en una ruta de acceso especificada con un modo de archivo especificado.Opens a package at a given path using a given file mode.

Open(String, FileMode, FileAccess)

Abre un paquete en una ruta de acceso especificada con un modo de archivo y la configuración de acceso de archivo especificados.Opens a package at a given path using a given file mode and file access setting.

Open(String, FileMode, FileAccess, FileShare)

Abre un paquete en una ruta de acceso especificada con un modo de archivo, acceso de archivo y configuración de uso compartido de archivos especificados.Opens a package at a given path using a given file mode, file access, and file share setting.

PartExists(Uri)

Indica si un elemento con un URI especificado está en el paquete.Indicates whether a part with a given URI is in the package.

RelationshipExists(String)

Indica si una relación de nivel de paquete con un identificador especificado está contenida en el paquete.Indicates whether a package-level relationship with a given ID is contained in the package.

ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

IDisposable.Dispose()

Este miembro admite la infraestructura de Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF) y no tiene fines de uso de aplicación.This member supports the Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF) infrastructure and is not intended for application use. Utilice el método Dispose(Boolean) con seguridad de tipos en su lugar.Use the type-safe Dispose(Boolean) method instead.

Se aplica a

Consulte también: