Package.DeleteRelationship Method (String)

 

Deletes a package-level relationship.

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

Public Sub DeleteRelationship (
	id As String
)

Parameters

id
Type: System.String

The Id of the PackageRelationship to delete.

Exception Condition
ArgumentNullException

id is null.

ObjectDisposedException

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

IOException

The package is read-only.

XmlException

id is not a valid XML identifier.

A package-level relationship defines an association between the package and an associated target part or resource. A package-level relationship can be one of two forms.

  • Between a Package to a target part in the package.

  • Between a Package to a target resource outside the package.

In a package-relationship the package is considered the "owner" of the relationship. When the package is deleted, all the relationships owned by the package are also deleted.

No exception is raised if a relationship with the specified id is not in the package.

DeleteRelationship does not physically change the target part in any way.

For more information about package relationships, see section 1.3 of the Open Packaging Conventions (OPC) specification available for download at http://go.microsoft.com/fwlink/?LinkID=71255.

.NET Framework
Available since 3.0
Return to top
Show: