TX Text Control .NET for Windows Forms

HyperlinkDialog Class

Class|Introduced in 23.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Windows.Forms.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Windows.Forms.dll from the setup.
Inherits
  1. Form
  2. HyperlinkDialog

Description

The HyperlinkDialog class implements a Windows Forms 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 HyperlinkDialog.DialogItem enumeration. The HyperlinkDialog.FindItem method can be used to get a certain item and manipulate, move or delete it. The HyperlinkDialog is a modal dialog box which must be shown with the HyperlinkDialog.ShowDialog method.

Syntax

public class HyperlinkDialog : Form

Examples

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

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

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

using HyperlinkDialog hyperlinkDialog = new(new TextControl());
hyperlinkDialog.AllowTransparency = true;

Members

Constructors

ConstructorDescription
HyperlinkDialogCreates a HyperlinkDialog object for the specified Windows Forms TextControl.

Methods

MethodDescription
FindItemFinds a control that has the provided identifier name.

Fields

FieldDescription
TXITEM_AutoGenerationBookmarksNot described in the reference. public CheckBox TXITEM_AutoGenerationBookmarks;
TXITEM_BookmarkListNot described in the reference. public ListBox TXITEM_BookmarkList;
TXITEM_BookmarkListLabelNot described in the reference. public Label TXITEM_BookmarkListLabel;
TXITEM_CancelNot described in the reference. public System.Windows.Forms.Button TXITEM_Cancel;
TXITEM_CurrentDocumentNot described in the reference. public RadioButton TXITEM_CurrentDocument;
TXITEM_DecriptiveTextLabelNot described in the reference. public Label TXITEM_DecriptiveTextLabel;
TXITEM_DeleteHyperlinkNot described in the reference. public System.Windows.Forms.Button TXITEM_DeleteHyperlink;
TXITEM_DescriptiveTextNot described in the reference. public TextBox TXITEM_DescriptiveText;
TXITEM_HyperlinkNot described in the reference. public TextBox TXITEM_Hyperlink;
TXITEM_HyperlinkLabelNot described in the reference. public Label TXITEM_HyperlinkLabel;
TXITEM_HyperlinkTextNot described in the reference. public TextBox TXITEM_HyperlinkText;
TXITEM_HyperlinkTextLabelNot described in the reference. public Label TXITEM_HyperlinkTextLabel;
TXITEM_OKNot described in the reference. public System.Windows.Forms.Button TXITEM_OK;
TXITEM_SelectedFileNot described in the reference. public RadioButton TXITEM_SelectedFile;
TXITEM_SelectFileNot described in the reference. public System.Windows.Forms.Button TXITEM_SelectFile;

Enumerations

EnumerationDescription
DialogItemEach DialogItem represents an item in a HyperlinkDialog dialog box. The corresponding string of a DialogItem is the same as the item's Name property. The DialogItem enumeration can be used with the HyperlinkDialog.FindItem method to get the item and manipulate it.