Package クラス

リファレンス

定義

名前空間:: System.IO.Packaging

アセンブリ:: System.IO.Packaging.dll

アセンブリ:: WindowsBase.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

複数のデータオブジェクトを格納可能なコンテナーを表します。

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 要素も含まれています。 1 つ目の "パッケージレベル" リレーションシップは、ドキュメントパーツをパッケージのルート要素として定義します。 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 サービスなどの他の物理形式を使用する場合があります。

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

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

A PackagePart ("part") は、 Package.

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

(メソッドによって作成される) パッケージレベルの Package.CreateRelationship リレーションシップは、次のいずれかに関連します Package 。
- パッケージ内のターゲットパーツ。
- パッケージの外部にあるターゲットリソース。
(メソッドによって作成される) パートレベルの PackagePart.CreateRelationship リレーションシップは、ソース PackagePart を次のいずれかに関連付けられます。
- パッケージ内の別のターゲットパーツ。
- パッケージの外部にあるターゲットリソース。

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

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

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

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

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

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

コンストラクター

Package(FileAccess)	指定した Package を使用する FileAccess クラスの新しいインスタンスを初期化します。
Package(FileAccess, Boolean)	指定した 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)	指定した ID を持つパッケージレベルリレーションシップを返します。
GetRelationships()	すべてのパッケージレベルリレーションシップのコレクションを返します。
GetRelationshipsByType(String)	指定した RelationshipType に一致するすべてのパッケージレベルリレーションシップのコレクションを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
Open(Stream)	指定した IO ストリームでパッケージを開きます。
Open(Stream, FileMode)	指定した IO ストリームとファイルモードでパッケージを開きます。
Open(Stream, FileMode, FileAccess)	指定した IO ストリーム、ファイルモード、およびファイルアクセス設定でパッケージを開きます。
Open(String)	指定したパスとファイル名でパッケージを開きます。
Open(String, FileMode)	指定したファイルモードを使用して、指定したパスにあるパッケージを開きます。
Open(String, FileMode, FileAccess)	指定したファイルモードとファイルアクセス設定を使用して、指定したパスにあるパッケージを開きます。
Open(String, FileMode, FileAccess, FileShare)	指定したファイルモード、ファイルアクセス、およびファイル共有設定を使用して、指定したパスにあるパッケージを開きます。
PartExists(Uri)	指定した URI を持つパーツがパッケージ内に存在するかどうかを示します。
RelationshipExists(String)	指定した ID を持つパッケージレベルリレーションシップがパッケージに含まれているかどうかを示します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

明示的なインターフェイスの実装

IDisposable.Dispose()

このメンバーは、Windows Presentation Foundation (WPF) インフラストラクチャをサポートしており、アプリケーションを使用するためのものではありません。代わりに、タイプセーフ Dispose(Boolean) メソッドを使用します。

適用対象