Package Sınıf

Tanım

Ad Alanı:

System.IO.Packaging

Bütünleştirilmiş Kod:

System.IO.Packaging.dll

Paket:

System.IO.Packaging v9.0.0-rc.1.24431.7

Kaynak:

Package.cs

Birden çok veri nesnesini depolayan bir kapsayıcıyı temsil eder.

public ref class Package abstract : IDisposable

public abstract class Package : IDisposable

type Package = class
    interface IDisposable

Public MustInherit Class Package
Implements IDisposable

Devralma

Object

Package

Türetilmiş

System.IO.Packaging.ZipPackage

Örnekler

Aşağıdaki örnekte, oluşturmanın temel adımları gösterilmektedir Package. Bu örnekte, belgenin bir parçası olarak görüntülenen grafik görüntüsüyle birlikte belgeyi içeren bir paket oluşturulur. (Bu, html dosyasının <Dış görüntü dosyasına başvuran IMG> etiketi.) Pakete iki PackageRelationship öğe de dahil edilir. İlki olan "paket düzeyi" ilişkisi, belge bölümünü paketin kök öğesi olarak tanımlar. İkinci bir "parça düzeyi" ilişkisi, belge bölümü (bölüm düzeyi ilişkisinin "kaynağı") ile resim bölümünün (bölüm düzeyi ilişkisinin "hedefi") kullanımı arasındaki ilişkiyi tanımlar.

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

Açıklamalar

Package , nesneleri taşınabilirlik ve verimli erişim için tanımlı fiziksel biçimin tek bir varlığında düzenlemek için kullanılabilecek soyut bir sınıftır.

ZIP dosyası, için Packagebirincil fiziksel biçimdir. Diğer Package uygulamalar XML belgesi, veritabanı veya Web hizmeti gibi diğer fiziksel biçimleri kullanabilir.

Dosya sistemi gibi, içinde yer alan öğelere Package de klasörler ve dosyaların hiyerarşik bir kuruluşunda başvurulur.

Kendisi soyut bir sınıf olsa Package da, ZipPackage türetilen sınıf yöntemi tarafından Open varsayılan olarak kullanılır.

(" PackagePart bölüm"), içinde depolanan Packagebir nesneyi temsil eden soyut sınıftır.

(" PackageRelationship ilişki"), bir kaynak Package veya PackagePart hedef nesne arasındaki ilişkiyi tanımlar. , PackageRelationship her biri iki biçimden biri olabilecek iki türden biri olabilir:

• Paket düzeyi ilişki (yöntemi tarafından Package.CreateRelationship oluşturulan) ile Package aşağıdakilerden biri arasında ilişki vardır:

  • Paketteki bir hedef bölüm.
  • Paketin dışında bir hedef kaynak.

• Parça düzeyi ilişki (yöntemi tarafından PackagePart.CreateRelationship oluşturulan) bir kaynağı PackagePart aşağıdakilerden biriyle ilişkilendirmektedir:

  • Paketteki başka bir hedef bölüm.
  • Paketin dışında bir hedef kaynak.

İlişkinin kaynağı Package veya kaynağı PackagePart , ilişkinin "sahibi" olarak kabul edilir. Kaynak nesne silindiğinde, kaynak nesnenin sahip olduğu tüm ilişkiler de silinir. İlişki oluşturma veya silme işlemi, kaynak veya hedef nesneleri herhangi bir şekilde fiziksel olarak değiştirmez.

(" PackageDigitalSignature dijital imza"), bir ile birlikte verilen dijital imzayı temsil eden parça ve ilişkilerin bileşimidir Package. Dijital imza, göndereni tanımlar ve içinde yer alan Package imzalı parçaların ve ilişkilerin değiştirilmediğini doğrular.

Paketler ayrıca bir Package içindeki içerik öğelerinin yetkili kullanıcılara verilen belirli erişim haklarıyla şifrelenmesini sağlayan Dijital Hak Yönetimi'ni (DRM) destekler.

Mimariye Package bağlı olarak, açık XpsDocumentXML Kağıt Belirtimini (XPS) temel alarak belgeleri depolamak için tasarlanmış bir paket türüdür.

.NET Framework varsayılan olarak standart bir ZIP dosyası kullanarak sayfaların ve belgelerin içeriğini, kaynaklarını ve ilişkilerini depolamak için paketleri kullanır. Herhangi bir ZIP dosyasında olduğu gibi, uygulamanız sınıfları kullanarak System.IO.Packaging her tür veya sayıda veri dosyasını tek bir verimli erişim kapsayıcısında depolayabilir ve isteğe bağlı olarak koruyabilir.

Daha fazla bilgi için adresinden indirilebilen https://www.ecma-international.org/publications-and-standards/standards/ecma-376/Open Packaging Conventions (OPC) belirtimine bakın.

Oluşturucular

Package(FileAccess)

Belirli FileAccessbir kullanan sınıfının yeni bir örneğini Package başlatır.

Özellikler

FileOpenAccess	Paketin dosya erişim ayarını alır.
PackageProperties	Paketin temel özelliklerini alır.

Yöntemler

Close()	Paketin yanı sıra temel alınan tüm parça akışlarını kaydeder ve kapatır.
CreatePart(Uri, String)	Belirli bir URI'ye ve içerik türüne sahip sıkıştırılmamış yeni bir bölüm oluşturur.
CreatePart(Uri, String, CompressionOption)	Belirli bir URI, içerik türü ve sıkıştırma seçeneğiyle yeni bir parça oluşturur.
CreatePartCore(Uri, String, CompressionOption)	Türetilmiş bir sınıfta geçersiz kılındığında, pakette yeni bir parça oluşturur.
CreateRelationship(Uri, TargetMode, String)	Belirli bir URI, hedef mod ve ilişki türüne sahip bir parçayla paket düzeyinde ilişki oluşturur.
CreateRelationship(Uri, TargetMode, String, String)	Belirli bir URI, hedef mod, ilişki türü ve tanımlayıcıya (Kimlik) sahip bir parçayla paket düzeyinde ilişki oluşturur.
DeletePart(Uri)	Belirli bir URI'ye sahip bir bölümü paketten siler.
DeletePartCore(Uri)	Türetilmiş bir sınıfta geçersiz kılındığında, belirli bir URI'ye sahip bir bölümü siler.
DeleteRelationship(String)	Paket düzeyi ilişkiyi siler.
Dispose(Boolean)	Tüm parçaların ve ilişkilerin içeriğini temizler ve kaydeder, paketi kapatır ve tüm kaynakları serbest bırakır.
Equals(Object)	Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler. (Devralındığı yer: Object)
Flush()	Paketin içerdiği tüm parçaların ve ilişkilerin içeriğini kaydeder.
FlushCore()	Türetilmiş bir sınıfta geçersiz kılındığında, tüm parçaların ve ilişkilerin içeriğini türetilmiş sınıf deposuna kaydeder.
GetHashCode()	Varsayılan karma işlevi işlevi görür. (Devralındığı yer: Object)
GetPart(Uri)	Belirli bir URI'ye sahip bölümü döndürür.
GetPartCore(Uri)	Türetilmiş bir sınıfta geçersiz kılındığında, belirli bir URI tarafından ele alınan bölümü döndürür.
GetParts()	Paketteki tüm parçaların koleksiyonunu döndürür.
GetPartsCore()	Türetilmiş bir sınıfta geçersiz kılındığında, paketteki tüm parçaların bir dizisini döndürür.
GetRelationship(String)	Belirli bir tanımlayıcıyla paket düzeyi ilişkisini döndürür.
GetRelationships()	Tüm paket düzeyi ilişkilerinin bir koleksiyonunu döndürür.
GetRelationshipsByType(String)	Belirli RelationshipTypebir ile eşleşen tüm paket düzeyi ilişkilerinin koleksiyonunu döndürür.
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
Open(Stream)	Belirli bir GÇ akışında bir paket açar.
Open(Stream, FileMode)	Belirli bir GÇ akışına ve dosya moduna sahip bir paket açar.
Open(Stream, FileMode, FileAccess)	Belirli bir GÇ akışı, dosya modu ve dosya erişimi ayarına sahip bir paket açar.
Open(String)	Belirli bir yolda ve dosya adında bir paket açar.
Open(String, FileMode)	Belirli bir dosya modunu kullanarak belirli bir yolda bir paket açar.
Open(String, FileMode, FileAccess)	Belirli bir dosya modunu ve dosya erişim ayarını kullanarak belirli bir yolda bir paket açar.
Open(String, FileMode, FileAccess, FileShare)	Belirli bir dosya modu, dosya erişimi ve dosya paylaşımı ayarını kullanarak belirli bir yolda bir paket açar.
PartExists(Uri)	Belirli bir URI'ye sahip bir bölümün pakette olup olmadığını gösterir.
RelationshipExists(String)	Belirli bir kimlikle paket düzeyi ilişkisinin pakette yer alıp almadığını gösterir.
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Belirtik Arabirim Kullanımları

IDisposable.Dispose()

Bu üye Windows Presentation Foundation (WPF) altyapısını destekler ve uygulama kullanımı için tasarlanmamıştır. Bunun yerine tür açısından güvenli Dispose(Boolean) yöntemini kullanın.

Ayrıca bkz.

• PackagePart
• XpsDocument
• Open Packaging Conventions (OPC) Belirtimi