OpenXmlPartContainer.AddHyperlinkRelationship Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
| AddHyperlinkRelationship(Uri, Boolean) |
Adds a new hyperlink relationship. |
| AddHyperlinkRelationship(Uri, Boolean, String) |
Adds a new hyperlink relationship. |
Adds a new hyperlink relationship.
C#
public DocumentFormat.OpenXml.Packaging.HyperlinkRelationship AddHyperlinkRelationship (Uri hyperlinkUri, bool isExternal);member this.AddHyperlinkRelationship : Uri * bool -> DocumentFormat.OpenXml.Packaging.HyperlinkRelationshipPublic Function AddHyperlinkRelationship (hyperlinkUri As Uri, isExternal As Boolean) As HyperlinkRelationshipParameters
- hyperlinkUri
- Uri
The URI of the hyperlink.
- isExternal
- Boolean
Is the hyperlink external to the OpenXmlPackage.
Returns
An HyperlinkRelationship with the relationship ID.
Exceptions
Thrown when "hyperlinkUri" is null reference.
Applies to
DocumentFormat.OpenXml 3.0.1 and other versions
| Product | Versions |
|---|---|
| DocumentFormat.OpenXml | 2.7.1, 2.7.2, 2.8.0, 2.8.1, 2.9.0, 2.9.1, 2.10.0, 2.10.1, 2.11.0, 2.11.1, 2.11.2, 2.11.3, 2.12.0, 2.12.1, 2.12.2, 2.12.3, 2.13.0, 2.13.1, 2.14.0, 2.15.0, 2.16.0, 2.17.1, 2.18.0, 2.19.0, 2.20.0, 3.0.0, 3.0.1 |
Adds a new hyperlink relationship.
C#
public DocumentFormat.OpenXml.Packaging.HyperlinkRelationship AddHyperlinkRelationship (Uri hyperlinkUri, bool isExternal, string id);member this.AddHyperlinkRelationship : Uri * bool * string -> DocumentFormat.OpenXml.Packaging.HyperlinkRelationshipPublic Function AddHyperlinkRelationship (hyperlinkUri As Uri, isExternal As Boolean, id As String) As HyperlinkRelationshipParameters
- hyperlinkUri
- Uri
The URI of the hyperlink.
- isExternal
- Boolean
Is the hyperlink external to the OpenXmlPackage.
- id
- String
The desired relationship ID.
Returns
An HyperlinkRelationship with the relationship ID.
Exceptions
Thrown when "hyperlinkUri" or "id" is null reference.
Applies to
DocumentFormat.OpenXml 3.0.1 and other versions
| Product | Versions |
|---|---|
| DocumentFormat.OpenXml | 2.7.1, 2.7.2, 2.8.0, 2.8.1, 2.9.0, 2.9.1, 2.10.0, 2.10.1, 2.11.0, 2.11.1, 2.11.2, 2.11.3, 2.12.0, 2.12.1, 2.12.2, 2.12.3, 2.13.0, 2.13.1, 2.14.0, 2.15.0, 2.16.0, 2.17.1, 2.18.0, 2.19.0, 2.20.0, 3.0.0, 3.0.1 |