PackagePart.DeleteRelationship(String) Method

Definition

Namespace:

System.IO.Packaging

Assembly:

System.IO.Packaging.dll

Package:

System.IO.Packaging v9.0.0-preview.3.24172.9

Source:

PackagePart.cs

Deletes a specified part-level PackageRelationship.

public:
 void DeleteRelationship(System::String ^ id);

public void DeleteRelationship (string id);

member this.DeleteRelationship : string -> unit

Public Sub DeleteRelationship (id As String)

Parameters

id

String

The Id of the relationship to delete.

Exceptions

InvalidOperationException

The part has been deleted.

-or-

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

ArgumentNullException

id is null.

IOException

The package is read-only (relationships cannot be deleted).

XmlException

id is not a valid XML identifier.

Remarks

id must be a valid XML identifier. The id type is xsd:ID and must follow the naming conventions prescribed in the XML Schema Part 2: Datatypes specification (see https://www.w3.org/TR/xmlschema-2/#ID).

If the specified id does not match the Id for any of the relationships that are owned by this part, no relationship is deleted and no exception is thrown.

Other than deleting the specified relationship, the DeleteRelationship method does not physically change either this part or the target part.

See also

• CreateRelationship
• GetRelationship(String)
• GetRelationships()
• RelationshipExists(String)
• GetRelationshipsByType(String)