Package Clase

Definición

Espacio de nombres:

System.IO.Packaging

Ensamblado:

System.IO.Packaging.dll

Paquete:

System.IO.Packaging v9.0.0-rc.1.24431.7

Source:

Package.cs

Representa un contenedor que puede almacenar varios objetos de datos.

public ref class Package abstract : IDisposable

public abstract class Package : IDisposable

type Package = class
    interface IDisposable

Public MustInherit Class Package
Implements IDisposable

Herencia

Object

Package

Derivado

System.IO.Packaging.ZipPackage

Ejemplos

En el ejemplo siguiente se muestran los pasos básicos para crear un Package. En este ejemplo, se crea un paquete para contener un documento junto con una imagen gráfica que se muestra como parte del documento. (Esto es similar al caso en el que un archivo HTML tiene un <Etiqueta IMG> que hace referencia a un archivo de imagen externo). También se incluyen dos PackageRelationship elementos en el paquete. La primera, una relación de "nivel de paquete", define la parte del documento como elemento raíz del paquete. Una segunda relación de "nivel de parte" define la asociación entre la parte del documento (el "origen" de la relación de nivel de parte) y su uso de la parte de imagen (el "destino" de la relación de nivel de parte).

//  -------------------------- 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 usar para organizar los objetos en una sola entidad de un formato físico definido para la portabilidad y el acceso eficaz.

Un archivo ZIP es el formato físico principal para .Package Otras Package implementaciones pueden usar otros formatos físicos, como un documento XML, una base de datos o un servicio web.

Al igual que un sistema de archivos, se hace referencia a los elementos contenidos en Package una organización jerárquica de carpetas y archivos.

Aunque Package se trata de una clase abstracta, la ZipPackage clase derivada se usa de forma predeterminada por el Open método .

Un PackagePart ("part") es la clase abstracta que representa un objeto almacenado en .Package

Un PackageRelationship ("relación") define una asociación entre un Package origen o PackagePart un objeto de destino. Un PackageRelationship puede ser uno de dos tipos, cada uno de los cuales puede ser una de estas dos formas:

• Una relación de nivel de paquete (creada por el Package.CreateRelationship método ) relaciona una Package relación con:

  • Una parte de destino del paquete.
  • Un recurso de destino fuera del paquete.

• Una relación de nivel de parte (creada por el PackagePart.CreateRelationship método) relaciona un origen PackagePart con:

  • Otra parte de destino del paquete.
  • Un recurso de destino fuera del paquete.

El origen Package o PackagePart origen de la relación se considera el "propietario" de la relación. Cuando se elimina el objeto de origen, también se eliminan todas las relaciones que pertenecen al objeto de origen. 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.

Una PackageDigitalSignature ("firma digital") es una composición de partes y relaciones que representan una firma digital incluida con .Package La firma digital identifica al autor y valida que las partes y relaciones firmadas contenidas en no Package se han modificado.

Los paquetes también admiten Digital Rights Management (DRM), que permite cifrar los elementos de contenido de con Package derechos de acceso específicos concedidos a los usuarios autorizados.

En función de la Package arquitectura, es XpsDocument un tipo de paquete diseñado para almacenar documentos basados en la especificación de papel XML abierta (XPS).

.NET Framework usa paquetes para almacenar contenido, recursos y relaciones para páginas y documentos mediante un archivo ZIP estándar de forma predeterminada. Al igual que con cualquier archivo ZIP, la aplicación puede usar las System.IO.Packaging clases para almacenar y, opcionalmente, proteger cualquier tipo o número de archivos de datos en un único contenedor eficaz para acceder.

Para obtener más información, consulte la especificación De convenciones de empaquetado abierto (OPC) disponible para su descarga en https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.

Constructores

Package(FileAccess)

Inicializa una nueva instancia de la clase Package con FileAccess especificada.

Propiedades

FileOpenAccess	Obtiene la configuración de acceso de archivos del paquete.
PackageProperties	Obtiene las propiedades básicas del paquete.

Métodos

Close()	Guarda y cierra el paquete más todas las secuencias de los elementos subyacentes.
CreatePart(Uri, String)	Crea un nuevo elemento sin comprimir con un URI y el tipo de contenido especificados.
CreatePart(Uri, String, CompressionOption)	Crea un nuevo elemento con un URI, tipo de contenido y opción de compresión especificados.
CreatePartCore(Uri, String, CompressionOption)	Cuando se invalida en una clase derivada, crea un nuevo elemento en el paquete.
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.
CreateRelationship(Uri, TargetMode, String, String)	Crea una relación de nivel de paquete con un elemento con un URI determinado, el modo de destino, el tipo de relación y el identificador (ID).
DeletePart(Uri)	Elimina un elemento con un URI especificado desde el paquete.
DeletePartCore(Uri)	Cuando se invalida en una clase derivada, elimina un elemento con un URI especificado.
DeleteRelationship(String)	Elimina una relación de nivel del paquete.
Dispose(Boolean)	Vacía y guarda el contenido de todos los elementos y relaciones, cierra el paquete y libera todos los recursos.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
Flush()	Guarda el contenido de todos los elementos y relaciones contenidos en el paquete.
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.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetPart(Uri)	Devuelve el elemento con un URI especificado.
GetPartCore(Uri)	Cuando se invalida en una clase derivada, devuelve el elemento tratado por un URI especificado.
GetParts()	Devuelve una colección de todos los elementos en el paquete.
GetPartsCore()	Cuando se invalida en una clase derivada, devuelve una matriz de todos los elementos del paquete.
GetRelationship(String)	Devuelve la relación de nivel de paquete con un identificador especificado.
GetRelationships()	Devuelve una colección de todas las relaciones de nivel de paquete.
GetRelationshipsByType(String)	Devuelve una colección de todas las relaciones de nivel de paquete que coincidan con una propiedad RelationshipType especificada.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
Open(Stream)	Abre un paquete en una secuencia de E/S especificada.
Open(Stream, FileMode)	Abre un paquete con una secuencia de E/S y un modo de archivo especificados.
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.
Open(String)	Abre un paquete en una ruta de acceso y un nombre de archivo especificados.
Open(String, FileMode)	Abre un paquete en una ruta de acceso especificada con un modo de archivo especificado.
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.
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.
PartExists(Uri)	Indica si un elemento con un URI especificado está en el paquete.
RelationshipExists(String)	Indica si una relación de nivel de paquete con un identificador especificado está contenida en el paquete.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

IDisposable.Dispose()

Este miembro admite la infraestructura de Windows Presentation Foundation (WPF) y no está pensada para el uso de la aplicación. Utilice el método Dispose(Boolean) con seguridad de tipos en su lugar.

Consulte también

• PackagePart
• XpsDocument
• Especificación de convenciones de empaquetado abierto (OPC)