Package Класс

Определение

Пространство имен:

System.IO.Packaging

Сборка:

System.IO.Packaging.dll

Пакет:

System.IO.Packaging v8.0.0

Исходный код:

Package.cs

Представляет контейнер, который может хранить несколько объектов данных.

public ref class Package abstract : IDisposable

public abstract class Package : IDisposable

type Package = class
    interface IDisposable

Public MustInherit Class Package
Implements IDisposable

Наследование

Object

Package

Производный

System.IO.Packaging.ZipPackage

Примеры

В следующем примере показаны основные шаги по созданию Package. В этом примере создается пакет, содержащий документ вместе с графическим изображением, которое отображается как часть документа. (Это похоже на случай, когда HTML-файл содержит <Тег IMG> , который ссылается на внешний файл изображения.) В пакет также включены два PackageRelationship элемента. Во-первых, отношение уровня пакета, определяет часть документа как корневой элемент пакета. Вторая связь уровня части определяет связь между частью документа ("источником" связи на уровне части) и ее использованием части изображения ("целевой" связи уровня части). Полный пример см. в разделе Написание примера пакета.

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

Комментарии

Package — это абстрактный класс, который можно использовать для организации объектов в единую сущность определенного физического формата для переносимости и эффективного доступа.

ZIP-файл является основным физическим форматом Packageдля . Другие Package реализации могут использовать другие физические форматы, такие как XML-документ, база данных или веб-служба.

Как и в файловой системе, элементы, содержащиеся в Package , ссылаются в иерархической организации папок и файлов.

Хотя Package сам класс является абстрактным, производный ZipPackage класс используется методом по Open умолчанию.

( PackagePart "часть") — это абстрактный класс, представляющий объект , хранящийся в Package.

( PackageRelationship "связь") определяет связь между источником Package или PackagePart и целевым объектом. Может PackageRelationship иметь один из двух типов, каждый из которых может иметь одну из двух форм:

• Отношение на уровне пакета (созданное методом Package.CreateRelationship ) связывает с Package :

  • Целевая часть пакета.

  • Целевой ресурс за пределами пакета.

• Связь на уровне части (созданная методом PackagePart.CreateRelationship ) связывает источник PackagePart с:

  • Другая целевая часть в пакете.

  • Целевой ресурс за пределами пакета.

Источник Package или источник PackagePart связи считается "владельцем" связи. При удалении исходного объекта также удаляются все связи, принадлежащие исходному объекту. Процесс создания или удаления связи физически не изменяет ни исходный, ни целевой объекты.

("цифровая PackageDigitalSignature подпись") — это композиция частей и связей, представляющих цифровую подпись, включенную Packageв . Цифровая подпись идентифицирует инициатора и проверяет, что подписанные части и связи, содержащиеся в Package , не были изменены.

Пакеты также поддерживают управление цифровыми правами (DRM), которое позволяет шифровать элементы содержимого в Package с определенными правами доступа, предоставленными авторизованным пользователям.

В зависимости от Package архитектуры , представляет собой тип пакета, XpsDocument предназначенный для хранения документов на основе open XML Paper Specification (XPS).

платформа .NET Framework использует пакеты для хранения содержимого, ресурсов и связей для страниц и документов с помощью стандартного ZIP-файла по умолчанию. Как и в случае с любым ZIP-файлом, приложение может использовать System.IO.Packaging классы для хранения и при необходимости защиты файлов данных любого типа или количества в одном контейнере с эффективным доступом.

Дополнительные сведения см. в спецификации Open Packaging Conventions (OPC), доступной для скачивания по адресу https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.

Конструкторы

Package(FileAccess)

Инициализирует новый экземпляр класса Package, использующий заданный режим FileAccess.

Свойства

FileOpenAccess	Получает значение режима доступа к файлу для пакета.
PackageProperties	Получает основные свойства пакета.

Методы

Close()	Сохраняет и закрывает пакет, а также все базовые потоки частей.
CreatePart(Uri, String)	Создает новую несжатую часть с заданным URI и типом содержимого.
CreatePart(Uri, String, CompressionOption)	Создает новую часть с заданными значениями URI, типа содержимого и режима сжатия.
CreatePartCore(Uri, String, CompressionOption)	При переопределении в производном классе создает новую часть в пакете.
CreateRelationship(Uri, TargetMode, String)	Создает связь с частью на уровне пакета по заданным значениям URI, вида целевой части и типа связи.
CreateRelationship(Uri, TargetMode, String, String)	Создает связь на уровне пакета с частью с заданным универсальным кодом ресурса (URI), целевым режимом, типом связи и идентификатором (id).
DeletePart(Uri)	Удаляет из пакета часть с заданным URI.
DeletePartCore(Uri)	При переопределении в производном классе удаляет часть с заданным URI.
DeleteRelationship(String)	Удаляет связь уровня пакета.
Dispose(Boolean)	Очищает и сохраняет содержимое всех частей и связей, закрывает пакет и освобождает все ресурсы.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Flush()	Сохраняет содержимое всех частей и связей, имеющихся в пакете.
FlushCore()	При переопределении в производном классе сохраняет содержимое всех частей и связей в хранилище производного класса.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetPart(Uri)	Возвращает часть с заданным URI.
GetPartCore(Uri)	При переопределении в производном классе возвращает часть, адресованную заданным URI.
GetParts()	Возвращает коллекцию, состоящую из всех частей пакета.
GetPartsCore()	При переопределении в производном классе возвращает массив, состоящий из всех частей пакета.
GetRelationship(String)	Возвращает связь уровня пакета с заданным идентификатором.
GetRelationships()	Возвращает коллекцию, состоящую из всех связей уровня пакета.
GetRelationshipsByType(String)	Возвращает коллекцию, состоящую из всех связей уровня пакета с заданным типом RelationshipType.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
Open(Stream)	Открывает пакет в заданном потоке ввода-вывода.
Open(Stream, FileMode)	Открывает пакет в заданном потоке ввода-вывода в указанном файловом режиме.
Open(Stream, FileMode, FileAccess)	Открывает пакет в заданном потоке ввода-вывода с указанными значениями файлового режима и режима доступа к файлу.
Open(String)	Открывает пакет с указанным путем и именем файла.
Open(String, FileMode)	Открывает пакет на заданном пути в указанном файловом режиме.
Open(String, FileMode, FileAccess)	Открывает пакет на заданном пути с указанными значениями файлового режима и режима доступа к файлу.
Open(String, FileMode, FileAccess, FileShare)	Открывает пакет на заданном пути с указанными значениями файлового режима, режима доступа к файлу и режима общего доступа.
PartExists(Uri)	Показывает, содержится ли часть с заданным URI в пакете.
RelationshipExists(String)	Показывается, содержится ли в пакете связь уровня пакета с заданным идентификатором.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

IDisposable.Dispose()

Этот элемент поддерживает инфраструктуру Windows Presentation Foundation (WPF) и не предназначен для использования в приложениях. Использовать вместо этого типобезопасный метод Dispose(Boolean).

См. также раздел

• PackagePart
• XpsDocument
• Спецификация Open Packaging Conventions (OPC)