HyperlinkDialog Class

Description

The WPF.HyperlinkDialog class implements a built-in dialog box for inserting and editing a hyperlink at the current text input position. The dialog box inserts either a HypertextLink to an external location or a DocumentLink to a location in the same document. If there is such a link at the current input position, the data of the link is shown and can be edited. Furthermore the hyperlink at the current input position can be deleted. The dialog box can only be opened, if either HypertextLinkCollection.CanAdd returns true or if DocumentLinkCollection.GetItem() or HypertextLinkCollection.GetItem() does not return null. Otherwise, an exception occurs. Each item of the dialog box has a name, available through its Name property, which corresponds with a member of the WPF.HyperlinkDialog.DialogItem enumeration. The FrameworkElement.FindName method can be used to get a certain item and manipulate, move or delete it. The WPF.HyperlinkDialog is a modal dialog box which must be shown with the WPF.HyperlinkDialog.ShowDialog method.

Syntax

public class HyperlinkDialog : Window, IComponentConnector

Public Class HyperlinkDialog
    Inherits Window
    Implements IComponentConnector

Examples

The following example creates an HyperlinkDialog object and shows the dialog box:

HyperlinkDialog dlg = new HyperlinkDialog(textControl1);
dlg.ShowDialog();

Dim dlg As New HyperlinkDialog(textControl1)
dlg.ShowDialog()

The following example creates a Hyperlink Dialog instance and configures its allows transparency setting for a document workflow.

TXTextControl.WPF.HyperlinkDialog hyperlinkDialog = new(new TXTextControl.WPF.TextControl());
hyperlinkDialog.AllowsTransparency = true;

Dim hyperlinkDialog As New TXTextControl.WPF.HyperlinkDialog(New TXTextControl.WPF.TextControl())
hyperlinkDialog.AllowsTransparency = True

Members

Constructors

Methods

Enumerations