Package.GetRelationship(String) Method

Definition

Returns the package-level relationship with a given identifier.

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

Parameters

id
String

The Id of the relationship to return.

Returns

The package-level relationship with the specified id.

Exceptions

id is null.

id is not a valid XML identifier.

A relationship with the specified id is not in the package.

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

The package is write-only.

Remarks

id must be a valid XML identifier. The id type is xsd:ID and must follow the naming conventions prescribed in the section 3.3.8 of the XML Schema Part 2: Datatypes specification.

For additional information about packaging and 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/.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10

See also