Package Package Package Package Class

定義

複数のデータ オブジェクトを格納できるコンテナーを表します。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
継承
PackagePackagePackagePackage
派生
実装

次の例は、を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. (これは、外部イメージファイルを参照する<IMG > タグが HTML ファイルに含まれている場合と似ています)。パッケージPackageRelationshipには、2つの要素も含まれています。(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. 1つ目の "パッケージレベル" リレーションシップは、ドキュメントパーツをパッケージのルート要素として定義します。The first, a "package-level" relationship, defines the document part as the package's root element. 2つ目の "パーツレベル" リレーションシップは、ドキュメントパーツ (パーツレベルリレーションシップの "ソース") とイメージパーツ (パーツレベルリレーションシップの "ターゲット") の間の関連付けを定義します。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 ' 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 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 ' end:CopyStream()

注釈

Packageは、移植性と効率的なアクセスのために定義された物理形式の1つのエンティティにオブジェクトを編成するために使用できる抽象クラスです。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 ドキュメント、データベース、Web サービスなどの物理形式を使用できます。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.

それ自体は抽象クラスですがZipPackage 、派生クラスはOpenメソッドによって既定値として使用されます。 PackageAlthough Package itself is an abstract class, the ZipPackage derived class is used as default by the Open method.

("Part") は、 Packageに格納されているオブジェクトを表す抽象クラスです。 PackagePartA PackagePart ("part") is the abstract class that represents an object that is stored in a Package.

( PackageRelationship "Relationship") は、 PackagePartソースPackageオブジェクトとターゲットオブジェクトの間の関連付けを定義します。A PackageRelationship ("relationship") defines an association between a source Package or PackagePart and a target object. PackageRelationship 、次の2つのいずれかの型にすることができます。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.

A 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 、は open XML Paper Specification (XPS)に基づくドキュメントを格納するために設計されたパッケージの種類です。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クラスを使用して、1つの効率的なコンテナー内の任意の型または数のデータファイルを格納し、必要に応じて保護することができます。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.

詳細については、でhttps://go.microsoft.com/fwlink/?LinkID=71255ダウンロードできる Open パッケージング規則 (OPC) 仕様を参照してください。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) Package(FileAccess) Package(FileAccess)

指定した Package を使用する FileAccess クラスの新しいインスタンスを初期化します。Initializes a new instance of the Package class that uses a given FileAccess.

Package(FileAccess, Boolean) Package(FileAccess, Boolean) Package(FileAccess, Boolean) Package(FileAccess, Boolean)

指定した Package とストリーミング オプションを使用する FileAccess クラスの新しいインスタンスを初期化します。Initializes a new instance of the Package class that uses a given FileAccess and streaming option.

プロパティ

FileOpenAccess FileOpenAccess FileOpenAccess FileOpenAccess

パッケージのファイル アクセス設定を取得します。Gets the file access setting for the package.

PackageProperties PackageProperties PackageProperties PackageProperties

パッケージのコア プロパティを取得します。Gets the core properties of the package.

メソッド

Close() Close() Close() Close()

パッケージと、基になるすべてのパーツ ストリームを保存して閉じます。Saves and closes the package plus all underlying part streams.

CreatePart(Uri, String) CreatePart(Uri, String) CreatePart(Uri, String) CreatePart(Uri, String)

指定した URI とコンテンツ タイプを使用して、新しい非圧縮のパーツを作成します。Creates a new uncompressed part with a given URI and content type.

CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption) CreatePart(Uri, String, CompressionOption)

指定した URI、コンテンツ タイプ、および圧縮オプションを使用して、新しいパーツを作成します。Creates a new part with a given URI, content type, and compression option.

CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption) CreatePartCore(Uri, String, CompressionOption)

派生クラスでオーバーライドされると、新しいパーツをパッケージ内に作成します。When overridden in a derived class, creates a new part in the package.

CreateRelationship(Uri, TargetMode, String) CreateRelationship(Uri, TargetMode, String) CreateRelationship(Uri, TargetMode, String) 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) CreateRelationship(Uri, TargetMode, String, String) CreateRelationship(Uri, TargetMode, String, String) 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) DeletePart(Uri) DeletePart(Uri) DeletePart(Uri)

指定した URI を持つパーツをパッケージから削除します。Deletes a part with a given URI from the package.

DeletePartCore(Uri) DeletePartCore(Uri) DeletePartCore(Uri) DeletePartCore(Uri)

派生クラスでオーバーライドされると、指定した URI を持つパーツを削除します。When overridden in a derived class, deletes a part with a given URI.

DeleteRelationship(String) DeleteRelationship(String) DeleteRelationship(String) DeleteRelationship(String)

パッケージ レベル リレーションシップを削除します。Deletes a package-level relationship.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

すべてのパーツおよびリレーションシップの内容をフラッシュして保存し、パッケージを閉じ、すべてのリソースを解放します。Flushes and saves the content of all parts and relationships, closes the package, and releases all resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
Flush() Flush() Flush() Flush()

パッケージに含まれているすべてのパーツおよびリレーションシップの内容を保存します。Saves the contents of all parts and relationships that are contained in the package.

FlushCore() FlushCore() FlushCore() FlushCore()

派生クラスでオーバーライドされると、すべてのパーツとリレーションシップの内容を派生クラス ストアに保存します。When overridden in a derived class, saves the content of all parts and relationships to the derived class store.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetPart(Uri) GetPart(Uri) GetPart(Uri) GetPart(Uri)

指定した URI を持つパーツを返します。Returns the part with a given URI.

GetPartCore(Uri) GetPartCore(Uri) GetPartCore(Uri) GetPartCore(Uri)

派生クラスでオーバーライドされると、指定した URI によってアドレス指定されるパーツを返します。When overridden in a derived class, returns the part addressed by a given URI.

GetParts() GetParts() GetParts() GetParts()

パッケージに含まれているすべてのパーツのコレクションを返します。Returns a collection of all the parts in the package.

GetPartsCore() GetPartsCore() GetPartsCore() GetPartsCore()

派生クラスでオーバーライドされると、パッケージ内のすべてのパーツの配列を返します。When overridden in a derived class, returns an array of all the parts in the package.

GetRelationship(String) GetRelationship(String) GetRelationship(String) GetRelationship(String)

指定した ID を持つパッケージ レベル リレーションシップを返します。Returns the package-level relationship with a given identifier.

GetRelationships() GetRelationships() GetRelationships() GetRelationships()

すべてのパッケージ レベル リレーションシップのコレクションを返します。Returns a collection of all the package-level relationships.

GetRelationshipsByType(String) GetRelationshipsByType(String) GetRelationshipsByType(String) GetRelationshipsByType(String)

指定した RelationshipType に一致するすべてのパッケージ レベル リレーションシップのコレクションを返します。Returns a collection of all the package-level relationships that match a given RelationshipType.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
Open(Stream) Open(Stream) Open(Stream) Open(Stream)

指定した IO ストリームでパッケージを開きます。Opens a package on a given IO stream.

Open(Stream, FileMode) Open(Stream, FileMode) Open(Stream, FileMode) Open(Stream, FileMode)

指定した IO ストリームとファイル モードでパッケージを開きます。Opens a package with a given IO stream and file mode.

Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess) Open(Stream, FileMode, FileAccess)

指定した IO ストリーム、ファイル モード、およびファイル アクセス設定でパッケージを開きます。Opens a package with a given IO stream, file mode, and file access setting.

Open(String) Open(String) Open(String) Open(String)

指定したパスとファイル名でパッケージを開きます。Opens a package at a given path and file name.

Open(String, FileMode) Open(String, FileMode) Open(String, FileMode) Open(String, FileMode)

指定したファイル モードを使用して、指定したパスにあるパッケージを開きます。Opens a package at a given path using a given file mode.

Open(String, FileMode, FileAccess) Open(String, FileMode, FileAccess) Open(String, FileMode, FileAccess) 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) Open(String, FileMode, FileAccess, FileShare) Open(String, FileMode, FileAccess, FileShare) 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) PartExists(Uri) PartExists(Uri) PartExists(Uri)

指定した URI を持つパーツがパッケージ内に存在するかどうかを示します。Indicates whether a part with a given URI is in the package.

RelationshipExists(String) RelationshipExists(String) RelationshipExists(String) RelationshipExists(String)

指定した ID を持つパッケージ レベル リレーションシップがパッケージに含まれているかどうかを示します。Indicates whether a package-level relationship with a given ID is contained in the package.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

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

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() 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.

適用対象

こちらもご覧ください