Package Класс

Определение

Представляет контейнер, который может хранить несколько объектов данных.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
Наследование
Package
Производный
Реализации

Примеры

В следующем примере показаны основные шаги для создания Package.The following example shows the basic steps for creating a Package. В этом примере создается пакет, содержащий документ вместе с графическим изображением, которое отображается как часть документа.In this example, a package is created to contain a document together with a graphic image that is displayed as part of the document. (Это похоже на случай, когда HTML-файл имеет тег <IMG >, который ссылается на внешний файл изображения.) В пакет также включены два элемента PackageRelationship.(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. Первый объект, связь уровня пакета, определяет часть документа как корневой элемент пакета.The first, a "package-level" relationship, defines the document part as the package's root element. Вторая связь "уровень части" определяет связь между частью документа ("источником" связи уровня части) и ее использованием части изображения ("цель" отношения уровня части).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). Полный пример см. в разделе запись примера пакета.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

Комментарии

Package является абстрактным классом, который можно использовать для организации объектов в единую сущность определенного физического формата для обеспечения переносимости и эффективного доступа.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.

ZIP-файл — это основной физический формат Package.A ZIP file is the primary physical format for the Package. Другие реализации Package могут использовать другие физические форматы, такие как XML-документ, база данных или веб-служба.Other Package implementations might use other physical formats such as an XML document, a database, or Web service.

Как и в файловой системе, элементы, содержащиеся в Package, указываются в иерархической структуре папок и файлов.Like a file system, items contained in a Package are referenced in a hierarchical organization of folders and files.

Хотя Package сам является абстрактным классом, ZipPackage производный класс используется по умолчанию методом Open.Although Package itself is an abstract class, the ZipPackage derived class is used as default by the Open method.

PackagePart ("часть") является абстрактным классом, который представляет объект, хранящийся в Package.A PackagePart ("part") is the abstract class that represents an object that is stored in a Package.

PackageRelationship ("связь") определяет связь между исходным Package или PackagePart и целевым объектом.A PackageRelationship ("relationship") defines an association between a source Package or PackagePart and a target object. PackageRelationship может быть одним из двух типов, каждая из которых может быть одной из двух форм:A PackageRelationship can be one of two types, each of which can be one of two forms:

  • Связь уровня пакета (созданная методом Package.CreateRelationship) связывает Package с одним из следующих способов:A package-level relationship (created by the Package.CreateRelationship method) relates a Package to either:

    • Целевой элемент в пакете.A target part in the package.

    • Целевой ресурс за пределами пакета.A target resource outside the package.

  • Отношение уровня части (созданное методом PackagePart.CreateRelationship) связывает PackagePart источника с одним из следующих способов:A part-level relationship (created by the PackagePart.CreateRelationship method) relates a source PackagePart to either:

    • Другая Целевая часть в пакете.Another target part in the package.

    • Целевой ресурс за пределами пакета.A target resource outside the package.

Источник связи Package или исходный PackagePart считается "владельцем" связи.The relationship's source Package or source PackagePart is considered the "owner" of the relationship. При удалении исходного объекта все связи, принадлежащие исходному объекту, также удаляются.When the source object is deleted, all the relationships owned by the source object are also deleted. Процесс создания или удаления связи физически не изменяет исходные или целевые объекты каким-либо образом.The process of creating or deleting a relationship does not physically change either the source or target objects in any way.

PackageDigitalSignature ("Цифровая подпись") представляет собой композицию частей и отношений, представляющих цифровую подпись, включенную в Package.A PackageDigitalSignature ("digital signature") is a composition of parts and relationships representing a digital signature included with a Package. Цифровая подпись идентифицирует инициатора и проверяет, что подписанные части и связи, содержащиеся в Package, не были изменены.The digital signature identifies the originator and validates that the signed parts and relationships contained in the Package have not been modified.

Пакеты также поддерживают цифровые Rights Management (DRM), что позволяет шифровать элементы содержимого в Package с определенными правами доступа, предоставленными полномочным пользователям.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.

На основе архитектуры Package XpsDocument — это тип пакета, предназначенный для хранения документов на основе формата XPS (Open XML Paper Specification).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 использует пакеты для хранения содержимого, ресурсов и связей страниц и документов с помощью стандартного ZIP-файла по умолчанию.The .NET Framework uses packages to store content, resources, and relationships for pages and documents using a standard ZIP file by default. Как и в случае с любым ZIP-файлом, приложение может использовать System.IO.Packaging классы для хранения и, при необходимости, защиты любого типа или числа файлов данных в одном контейнере эффективного доступа.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.

Дополнительные сведения см. в спецификации Open Packaging Conventions (OPC), доступной для загрузки по адресу 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.

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

Package(FileAccess)

Инициализирует новый экземпляр класса Package, использующий заданный режим FileAccess.Initializes a new instance of the Package class that uses a given FileAccess.

Package(FileAccess, Boolean)

Инициализирует новый экземпляр класса Package, использующий заданный режим FileAccess и режим потока.Initializes a new instance of the Package class that uses a given FileAccess and streaming option.

Свойства

FileOpenAccess

Получает значение режима доступа к файлу для пакета.Gets the file access setting for the package.

PackageProperties

Получает основные свойства пакета.Gets the core properties of the package.

Методы

Close()

Сохраняет и закрывает пакет, а также все базовые потоки частей.Saves and closes the package plus all underlying part streams.

CreatePart(Uri, String)

Создает новую несжатую часть с заданным URI и типом содержимого.Creates a new uncompressed part with a given URI and content type.

CreatePart(Uri, String, CompressionOption)

Создает новую часть с заданными значениями URI, типа содержимого и режима сжатия.Creates a new part with a given URI, content type, and compression option.

CreatePartCore(Uri, String, CompressionOption)

При переопределении в производном классе создает новую часть в пакете.When overridden in a derived class, creates a new part in the package.

CreateRelationship(Uri, TargetMode, String)

Создает связь с частью на уровне пакета по заданным значениям URI, вида целевой части и типа связи.Creates a package-level relationship to a part with a given URI, target mode, and relationship type.

CreateRelationship(Uri, TargetMode, String, String)

Создает связь с частью на уровне пакета по заданным значениям URI, вида целевой части, типа связи и идентификатор (ID)identifier (ID).Creates a package-level relationship to a part with a given URI, target mode, relationship type, and идентификатор (ID)identifier (ID).

DeletePart(Uri)

Удаляет из пакета часть с заданным URI.Deletes a part with a given URI from the package.

DeletePartCore(Uri)

При переопределении в производном классе удаляет часть с заданным URI.When overridden in a derived class, deletes a part with a given URI.

DeleteRelationship(String)

Удаляет связь уровня пакета.Deletes a package-level relationship.

Dispose(Boolean)

Очищает и сохраняет содержимое всех частей и связей, закрывает пакет и освобождает все ресурсы.Flushes and saves the content of all parts and relationships, closes the package, and releases all resources.

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Flush()

Сохраняет содержимое всех частей и связей, имеющихся в пакете.Saves the contents of all parts and relationships that are contained in the package.

FlushCore()

При переопределении в производном классе сохраняет содержимое всех частей и связей в хранилище производного класса.When overridden in a derived class, saves the content of all parts and relationships to the derived class store.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetPart(Uri)

Возвращает часть с заданным URI.Returns the part with a given URI.

GetPartCore(Uri)

При переопределении в производном классе возвращает часть, адресованную заданным URI.When overridden in a derived class, returns the part addressed by a given URI.

GetParts()

Возвращает коллекцию, состоящую из всех частей пакета.Returns a collection of all the parts in the package.

GetPartsCore()

При переопределении в производном классе возвращает массив, состоящий из всех частей пакета.When overridden in a derived class, returns an array of all the parts in the package.

GetRelationship(String)

Возвращает связь уровня пакета с заданным идентификатором.Returns the package-level relationship with a given identifier.

GetRelationships()

Возвращает коллекцию, состоящую из всех связей уровня пакета.Returns a collection of all the package-level relationships.

GetRelationshipsByType(String)

Возвращает коллекцию, состоящую из всех связей уровня пакета с заданным типом RelationshipType.Returns a collection of all the package-level relationships that match a given RelationshipType.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
Open(Stream)

Открывает пакет в заданном потоке ввода-вывода.Opens a package on a given IO stream.

Open(Stream, FileMode)

Открывает пакет в заданном потоке ввода-вывода в указанном файловом режиме.Opens a package with a given IO stream and file mode.

Open(Stream, FileMode, FileAccess)

Открывает пакет в заданном потоке ввода-вывода с указанными значениями файлового режима и режима доступа к файлу.Opens a package with a given IO stream, file mode, and file access setting.

Open(String)

Открывает пакет с указанным путем и именем файла.Opens a package at a given path and file name.

Open(String, FileMode)

Открывает пакет на заданном пути в указанном файловом режиме.Opens a package at a given path using a given file mode.

Open(String, FileMode, FileAccess)

Открывает пакет на заданном пути с указанными значениями файлового режима и режима доступа к файлу.Opens a package at a given path using a given file mode and file access setting.

Open(String, FileMode, FileAccess, FileShare)

Открывает пакет на заданном пути с указанными значениями файлового режима, режима доступа к файлу и режима общего доступа.Opens a package at a given path using a given file mode, file access, and file share setting.

PartExists(Uri)

Показывает, содержится ли часть с заданным URI в пакете.Indicates whether a part with a given URI is in the package.

RelationshipExists(String)

Показывается, содержится ли в пакете связь уровня пакета с заданным идентификатором.Indicates whether a package-level relationship with a given ID is contained in the package.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

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

IDisposable.Dispose()

Данный член поддерживает инфраструктуру Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF) и не предназначен для использования в приложениях.This member supports the Windows Presentation Foundation (WPF)Windows Presentation Foundation (WPF) infrastructure and is not intended for application use. Использовать вместо этого типобезопасный метод Dispose(Boolean).Use the type-safe Dispose(Boolean) method instead.

Применяется к

Дополнительно