PackagePart.GetRelationship(String) Method

Reference

Definition

Namespace:: System.IO.Packaging

Assembly:: System.IO.Packaging.dll

Assembly:: WindowsBase.dll

Package:: System.IO.Packaging v6.0.0

Package:: System.IO.Packaging v7.0.0

Package:: System.IO.Packaging v8.0.0

Package:: System.IO.Packaging v9.0.0-preview.2.24128.5

Source:: PackagePart.cs

Source:: PackagePart.cs

Source:: PackagePart.cs

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.

Returns the relationship that has a specified Id.

public:
 System::IO::Packaging::PackageRelationship ^ GetRelationship(System::String ^ id);

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

member this.GetRelationship : string -> System.IO.Packaging.PackageRelationship

Public Function GetRelationship (id As String) As PackageRelationship

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.

ArgumentException

relationshipType is an empty string.

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