Table of Contents

Method AddHyperlinkToEmbeddedDocument

Namespace
MigraDoc.DocumentObjectModel
Assembly
MigraDoc.DocumentObjectModel.dll

AddHyperlinkToEmbeddedDocument(string, HyperlinkTargetWindow)

Adds a new Hyperlink of Type "EmbeddedDocument". The target is a Bookmark in an embedded Document in this Document.

public Hyperlink AddHyperlinkToEmbeddedDocument(string destinationPath, HyperlinkTargetWindow newWindow = HyperlinkTargetWindow.UserPreference)

Parameters

destinationPath string

The path to the named destination through the embedded documents. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the current (root or embedded) document to the embedded document holding the destination. ".." references to the parent, other strings refer to a child with this name in the EmbeddedFiles name dictionary.

newWindow HyperlinkTargetWindow

Defines if the HyperlinkType ExternalBookmark shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

Hyperlink

AddHyperlinkToEmbeddedDocument(string, string, HyperlinkTargetWindow)

Adds a new Hyperlink of Type "EmbeddedDocument". The target is a Bookmark in an embedded Document in an external PDF Document.

public Hyperlink AddHyperlinkToEmbeddedDocument(string filename, string destinationPath, HyperlinkTargetWindow newWindow = HyperlinkTargetWindow.UserPreference)

Parameters

filename string

The path to the target document. Can be empty if target is an embedded document in the current document.

destinationPath string

The path to the named destination through the embedded documents in the target document. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the root document to the embedded document. Each segment name refers to a child with this name in the EmbeddedFiles name dictionary.

newWindow HyperlinkTargetWindow

Defines if the HyperlinkType ExternalBookmark shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

Hyperlink