PackagePart.GetRelationship Method

Returns the relationship that has a specified Id.

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

public PackageRelationship GetRelationship(
	string id
)

Parameters

id
Type: System.String

The Id of the relationship to return.

Return Value

Type: System.IO.Packaging.PackageRelationship
The relationship that matches the specified id.

ExceptionCondition
ArgumentNullException

id is null.

XmlException

id is not a valid XML identifier.

ArgumentException

relationshipType is an empty string.

InvalidOperationException

The part has been deleted.

-or-

The Package is not open (Dispose 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).

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 http://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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft