Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
This topic has not yet been rated - Rate this topic

Package.CreateRelationship Method (Uri, TargetMode, String, String)

Creates a package-level relationship to a specified part with a given URI, target mode, relationship type, and identifier (ID).

Namespace: System.IO.Packaging
Assembly: WindowsBase (in windowsbase.dll)

public PackageRelationship CreateRelationship (
	Uri targetUri,
	TargetMode targetMode,
	string relationshipType,
	string id
)
public PackageRelationship CreateRelationship (
	Uri targetUri, 
	TargetMode targetMode, 
	String relationshipType, 
	String id
)
public function CreateRelationship (
	targetUri : Uri, 
	targetMode : TargetMode, 
	relationshipType : String, 
	id : String
) : PackageRelationship
You cannot use methods in XAML.

Parameters

targetUri

The uniform resource identifier (URI) of the target part.

targetMode

Indicates if the target part is Internal or External to the package.

relationshipType

A URI that uniquely defines the role of the relationship.

id

A unique XML identifier.

Return Value

The package-level relationship to the specified part.
Exception typeCondition

ArgumentNullException

targetUri or relationshipType is a null reference (Nothing in Visual Basic).

ArgumentException

The targetUri part is a PackageRelationship, or targetMode is Internal and targetUri is an absolute URI.

ArgumentOutOfRangeException

The value for targetMode is not valid.

ObjectDisposedException

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

IOException

The package is read-only.

XmlException

id is not a valid XML identifier; or a part with the specified id already occurs in the package.

A package-level relationship defines an association between the package and an associated target part or resource. A package-level relationship can be one of two forms.

  • Between a Package to a target part in the package.

  • Between a Package to a target resource outside the package.

In a package-relationship the package is considered the "owner" of the relationship. When the package is deleted, all the relationships owned by the package are also deleted.

CreateRelationship does not physically change the target part or resource in any way.

The target of a relationship cannot be another relationship.

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 http://www.w3.org/TR/xmlschema-2/#ID).

If id is specified as a null reference (Nothing in Visual Basic) a unique ID will be automatically generated. An id specified by an empty string is not valid.

If targetMode is specified as Internal, targetUri must be a relative URI that is formed according to the RFC 3986Uniform Resource Identifier (URI) Generic Syntax specification. The internal relative URI can be either an absolute path that starts with a forward slash ("/") character such as "/page1.xaml" or "/images/picture4.jpg", or a relative path such as "../imagespicture1.jpg" that resolves against the package root ("/") as the base URI.

If targetMode is specified as External, targetUri can be either an absolute or relative URI formed according to the RFC 3986Uniform Resource Identifier (URI) Generic Syntax specification. "http://www.microsoft.com/page2.xml" is an example of an absolute URI that references an external target resource "page2.xml". "images/picture1.jpg" is an example of a relative URI that also references an external target resource "1.jpg" but which resolves against the URI of the package itself.

relationshipType must be a URI that is formed according to the RFC 3986Uniform Resource Identifier (URI) Generic Syntax specification. The following table shows the package-level relationshipType URIs defined by the Open Packaging Conventions (OPC) specification.

Package-level Relationship

Relationship Type URI

Core Properties

http://schemas.openxmlformats.org/package/2006/relationships/meta data/core-properties

Digital Signature

http://schemas.openxmlformats.org/package/2006/relationships/digit al-signature/signature

Digital Signature Certificate

http://schemas.openxmlformats.org/package/2006/relationships/digit al-signature/certificate

Digital Signature Origin

http://schemas.openxmlformats.org/package/2006/relationships/digit al-signature/origin

Thumbnail

http://schemas.openxmlformats.org/package/2006/relationships/meta data/thumbnail

For additional information about packaging and package relationships see section 1.3 of the Open Packaging Conventions (OPC) specification available for download at http://go.microsoft.com/fwlink/?LinkID=71255.

The following example illustrates how to use CreateRelationship to create a PackageRelationship between a Package and a root document part. For the complete sample, see Writing a Package Sample.

// Add the Document part to the Package
PackagePart packagePartDocument =
    package.CreatePart(partUriDocument,
                   System.Net.Mime.MediaTypeNames.Text.Xml);

// Copy the data to the Document Part
using (FileStream fileStream = new FileStream(
       documentPath, FileMode.Open, FileAccess.Read))
{
    CopyStream(fileStream, packagePartDocument.GetStream());
}// end:using(fileStream) - Close and dispose fileStream.

// Add a Package Relationship to the Document Part
package.CreateRelationship(packagePartDocument.Uri,
                           TargetMode.Internal,
                           PackageRelationshipType);

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.