Edit

PackagePart.GetRelationshipsByType(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

Returns a collection of the relationships that match a specified RelationshipType.

public:
 System::IO::Packaging::PackageRelationshipCollection ^ GetRelationshipsByType(System::String ^ relationshipType);
public System.IO.Packaging.PackageRelationshipCollection GetRelationshipsByType (string relationshipType);
member this.GetRelationshipsByType : string -> System.IO.Packaging.PackageRelationshipCollection
Public Function GetRelationshipsByType (relationshipType As String) As PackageRelationshipCollection

Parameters

relationshipType
String

The RelationshipType of the relationships to locate and return in the collection.

Returns

PackageRelationshipCollection

A collection of the relationships that match the specified relationshipType.

Exceptions

ArgumentNullException

relationshipType is null.

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

IOException

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

Remarks

The returned collection is never null; however, the collection might contain zero elements if no relationships match the specified relationshipType that is defined for the part.

Any leading or trailing spaces in the relationshipType string are automatically trimmed.

Applies to

See also