Package クラス

定義

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

実装

IDisposable

例

次の例は、 Packageを作成するための基本的な手順を示しています。 この例では、ドキュメントの一部として表示されるグラフィック イメージと共にドキュメントを含むパッケージが作成されます。 (これは、HTML ファイルに <がある場合と似ています。IMG> 外部イメージ ファイルを参照するタグ。パッケージには、2 つの PackageRelationship 要素も含まれています。 最初の "パッケージ レベル" リレーションシップは、ドキュメント パーツをパッケージのルート要素として定義します。 2 つ目の "パーツ レベル" リレーションシップは、ドキュメント パーツ (パーツ レベルのリレーションシップの "ソース") とイメージ パーツの使用 (パーツ レベルリレーションシップの "ターゲット") との関連付けを定義します。

//  -------------------------- 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 ドキュメント、データベース、Web サービスなどの他の物理形式が使用される場合があります。

ファイル システムと同様に、 Package に含まれる項目は、フォルダーとファイルの階層構造で参照されます。

Package自体は抽象クラスですが、ZipPackage派生クラスは既定で Open メソッドによって使用されます。

PackagePart ("part") は、Packageに格納されているオブジェクトを表す抽象クラスです。

PackageRelationship ("リレーションシップ") は、ソース PackageまたはPackagePartとターゲット オブジェクトの間の関連付けを定義します。 PackageRelationshipには、次の 2 つの種類のいずれかを指定できます。それぞれの型は、次の 2 つの形式のいずれかになります。

• パッケージ レベルのリレーションシップ ( Package.CreateRelationship メソッドによって作成) は、 Package を次のいずれかに関連付けます。

  • パッケージ内のターゲット パーツ。
  • パッケージの外部にあるターゲット リソース。

• ( PackagePart.CreateRelationship メソッドによって作成される) パーツ レベルのリレーションシップは、ソース PackagePart を次のいずれかに関連付けます。

  • パッケージ内の別のターゲット パーツ。
  • パッケージの外部にあるターゲット リソース。

リレーションシップのソース Package またはソース PackagePart は、リレーションシップの "所有者" と見なされます。 ソース オブジェクトが削除されると、ソース オブジェクトによって所有されているすべてのリレーションシップも削除されます。 リレーションシップを作成または削除するプロセスでは、ソース オブジェクトまたはターゲット オブジェクトは物理的に変更されません。

PackageDigitalSignature ("デジタル署名") は、Packageに含まれるデジタル署名を表すパーツとリレーションシップの構成です。 デジタル署名は、発信者を識別し、 Package に含まれる署名済みパーツとリレーションシップが変更されていないことを検証します。

パッケージは Digital Rights Management (DRM) もサポートしています。これにより、承認されたユーザーに付与された特定のアクセス権を使用して、 Package 内のコンテンツ要素を暗号化できます。

Package アーキテクチャに基づいて、XpsDocumentは、開いている XML Paper Specification (XPS) に基づいてドキュメントを格納するために設計されたパッケージの種類です。

.NET Framework では、既定で標準の ZIP ファイルを使用して、パッケージを使用してページとドキュメントのコンテンツ、リソース、リレーションシップを格納します。 任意の ZIP ファイルと同様に、アプリケーションは System.IO.Packaging クラスを使用して、任意の種類または数のデータ ファイルを 1 つの効率的なアクセス コンテナーに格納し、必要に応じて保護できます。

詳細については、 https://www.ecma-international.org/publications-and-standards/standards/ecma-376/でダウンロードできる Open Packaging Conventions (OPC) 仕様を参照してください。

こちらもご覧ください

• PackagePart
• XpsDocument
• Open Packaging Conventions (OPC) 仕様