PackagePart.GetRelationship(String) Method

Definition

Namespace:

System.IO.Packaging

Assembly:

System.IO.Packaging.dll

Source:

PackagePart.cs

Returns the relationship that has a specified Id.

C#

public System.IO.Packaging.PackageRelationship GetRelationship(string id);

Parameters

id

String

The Id of the relationship to return.

Returns

PackageRelationship

The relationship that matches the specified id.

Exceptions

ArgumentNullException

id is null.

XmlException

id is not a valid XML identifier.

InvalidOperationException

The part has been deleted.

-or-

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

-or-

A relationship with the specified id does not exist in the package.

IOException

The package is write-only (relationship information cannot be read).

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

You can use the RelationshipExists method to determine if a relationship with a specified Id is owned by this part.

Applies to

See also

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