PackageRelationship Class

Definition

Represents an association between a source Package or PackagePart, and a target object which can be a PackagePart or external resource.

public ref class PackageRelationship
public class PackageRelationship
type PackageRelationship = class
Public Class PackageRelationship
Inheritance
PackageRelationship

Remarks

A PackageRelationship defines an association between a source Package or PackagePart to a target PackagePart or external resource. The source object is considered the "owner" of the relationship.

The PackageRelationship class has no public constructor; instead, two Create methods are used:

Package.CreateRelationship Creates a "package-level" relationship-from a package to a specified part or external resource.
PackagePart.CreateRelationship Creates a "part-level" relationship-from one part to another part or external resource.

The source package or part is identified by the SourceUri property of the relationship. The target part or external resource is identified by the TargetUri property of the relationship.

Creating or deleting a relationship does not affect the source or target objects in any way.

If a source object is deleted, all relationships owned by the object are also deleted.

Relationships enable navigation both in a document and between documents. Relationships also support document object model services, such as linking a PrintTicket to specific document elements when printing.

For more information about PackageRelationship elements see Section 1.3 "Relationships" in the Open Packaging Conventions specification available for download at https://go.microsoft.com/fwlink/?LinkID=71255.

Properties

Id

Gets a string that identifies the relationship.

Package

Gets the Package that contains this relationship.

RelationshipType

Gets the qualified type name of the relationship.

SourceUri

Gets the URI of the package or part that owns the relationship.

TargetMode

Gets a value that indicates whether the target of the relationship is Internal or External to the Package.

TargetUri

Gets the URI of the target resource of the relationship.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to