Package.GetRelationship(String) Method

Definition

Namespace:: System.IO.Packaging

Assembly:: System.IO.Packaging.dll

Assembly:: WindowsBase.dll

Returns the package-level relationship with a given identifier.

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 package-level relationship with the specified id.

Exceptions

ArgumentNullException

id is null.

XmlException

id is not a valid XML identifier.

InvalidOperationException

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

ObjectDisposedException

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

IOException

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://go.microsoft.com/fwlink/?LinkID=71255.

Applies to