OpenXmlPartContainer.AddHyperlinkRelationship Method

Definition

Namespace:

DocumentFormat.OpenXml.Packaging

Assembly:

DocumentFormat.OpenXml.Framework.dll

Package:

DocumentFormat.OpenXml.Framework v3.0.1

Overloads

AddHyperlinkRelationship(Uri, Boolean)	Adds a new hyperlink relationship.
AddHyperlinkRelationship(Uri, Boolean, String)	Adds a new hyperlink relationship.

AddHyperlinkRelationship(Uri, Boolean)

Adds a new hyperlink relationship.

public DocumentFormat.OpenXml.Packaging.HyperlinkRelationship AddHyperlinkRelationship (Uri hyperlinkUri, bool isExternal);

member this.AddHyperlinkRelationship : Uri * bool -> DocumentFormat.OpenXml.Packaging.HyperlinkRelationship

Public Function AddHyperlinkRelationship (hyperlinkUri As Uri, isExternal As Boolean) As HyperlinkRelationship

Parameters

hyperlinkUri

Uri

The URI of the hyperlink.

isExternal

Boolean

Is the hyperlink external to the OpenXmlPackage.

Returns

HyperlinkRelationship

An HyperlinkRelationship with the relationship ID.

Exceptions

ArgumentNullException

Thrown when "hyperlinkUri" is null reference.

AddHyperlinkRelationship(Uri, Boolean, String)

Adds a new hyperlink relationship.

public DocumentFormat.OpenXml.Packaging.HyperlinkRelationship AddHyperlinkRelationship (Uri hyperlinkUri, bool isExternal, string id);

member this.AddHyperlinkRelationship : Uri * bool * string -> DocumentFormat.OpenXml.Packaging.HyperlinkRelationship

Public Function AddHyperlinkRelationship (hyperlinkUri As Uri, isExternal As Boolean, id As String) As HyperlinkRelationship

Parameters

hyperlinkUri

Uri

The URI of the hyperlink.

isExternal

Boolean

Is the hyperlink external to the OpenXmlPackage.

id

String

The desired relationship ID.

Returns

HyperlinkRelationship

An HyperlinkRelationship with the relationship ID.

Exceptions

ArgumentNullException

Thrown when "hyperlinkUri" or "id" is null reference.