Package.CreatePart Method (Uri, String, CompressionOption)

 

Creates a new part with a given URI, content type, and compression option.

Namespace:   System.IO.Packaging
Assembly:  WindowsBase (in WindowsBase.dll)

Public Function CreatePart (
	partUri As Uri,
	contentType As String,
	compressionOption As CompressionOption
) As PackagePart

Parameters

partUri
Type: System.Uri

The URI of the new part.

contentType
Type: System.String

The content type of the data stream.

compressionOption
Type: System.IO.Packaging.CompressionOption

The compression option for the data stream, NotCompressed or Normal compression.

Return Value

Type: System.IO.Packaging.PackagePart

The new created part.

Exception Condition
ArgumentNullException

partUri or contentType is null.

ArgumentException

partUri is not a valid PackagePart uniform resource identifier (URI).

InvalidOperationException

A part with the specified partUri is already present in the package.

ArgumentOutOfRangeException

The compressionOption value is not valid.

ObjectDisposedException

The package is not open (Dispose or Close has been called).

IOException

The package is read-only (a new part cannot be added).

For the default ZipPackage derived class, the CreatePart method only supports two compressionOption values, NotCompressed or Normal compression. Other CompressionOption values of Maximum, Fast, or SuperFast use Normal compression.

CreatePart creates an empty Stream for the new part. The PackagePart.GetStream method can be used to obtain a reference to the stream instance associated with the part.

For additional information, see the Open Packaging Conventions (OPC) specification available for download at http://go.microsoft.com/fwlink/?LinkID=71255.

Notes to Inheritors:

CreatePart internally calls the derived class's CreatePartCore method to actually create the part based on the physical format implemented in the derived class.

The following example shows how to create a new PackagePart and then store data into the part. For the complete sample, see Writing a Package Sample.

' 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.

.NET Framework
Available since 3.0
Return to top
Show: