Edit

Package.GetParts Method

  • Reference

Definition

Namespace:
System.IO.Packaging
Assembly:
System.IO.Packaging.dll
Assembly:
WindowsBase.dll
Package:
System.IO.Packaging v6.0.0
Package:
System.IO.Packaging v7.0.0
Package:
System.IO.Packaging v8.0.0
Package:
System.IO.Packaging v9.0.0-preview.2.24128.5
Source:
Package.cs
Source:
Package.cs
Source:
Package.cs

Returns a collection of all the parts in the package.

public:
 System::IO::Packaging::PackagePartCollection ^ GetParts();
public System.IO.Packaging.PackagePartCollection GetParts ();
member this.GetParts : unit -> System.IO.Packaging.PackagePartCollection
Public Function GetParts () As PackagePartCollection

Returns

PackagePartCollection

A collection of all the PackagePart elements that are contained in the package.

Exceptions

ObjectDisposedException

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

IOException

The package is write-only.

Examples

The following example shows how to use the GetParts method to obtain a collection of the parts that are contained in a Package. For the complete program source code, see Creating a Package with a Digital Signature Sample.

Remarks

GetParts returns a collection of all parts that are contained in the package including PackageRelationship parts.

GetParts will never return null; however, the returned collection will contain zero elements if the package contains no parts.

By default, a ZipPackage derived implementation of the abstract Package base class is provided and used. In the default operation, GetParts calls the GetPartsCore method of the ZipPackage class to return the parts from a ZIP file.

For more information about packages and package parts, see section 1.1 of the Open Packaging Conventions (OPC) specification available for download at https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.

Notes to Inheritors

GetParts() internally calls the derived class GetPartsCore() method to actually flush the part based on the physical format implemented in the derived class.

Applies to

See also