Package.DeleteRelationship(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Deletes a package-level relationship.
public:
void DeleteRelationship(System::String ^ id);public void DeleteRelationship (string id);member this.DeleteRelationship : string -> unitPublic Sub DeleteRelationship (id As String)Parameters
- id
- String
The Id of the PackageRelationship to delete.
Exceptions
id is null.
The package is not open (Dispose(Boolean) or Close() has been called).
The package is read-only.
id is not a valid XML identifier.
Remarks
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 https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.
