TXTextControl.BookmarkDialog Class

The BookmarkDialog class implements a Windows Forms dialog box to insert a DocumentTarget at the current input position. If there is a target at the current input position, the name of the target is shown and can be edited. The dialog box can only be opened, if either DocumentTargetCollection.CanAdd returns true or if DocumentTargetCollection.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 BookmarkDialog.DialogItem enumeration. The BookmarkDialog.FindItem method can be used to get a certain item and manipulate, move or delete it. The BookmarkDialog is a modal dialog box which must be shown with the BookmarkDialog.ShowDialog method.

Introduced: 23.0.

Syntax

[C#]
public class BookmarkDialog : System.Windows.Forms.Form
[Visual Basic]
Public Class BookmarkDialog
  Inherits System.Windows.Forms.Form

Constructors

Constructor Description
BookmarkDialog Creates a BookmarkDialog object for the specified Windows Forms TextControl.

Methods

Method Description
FindItem Finds a control that has the provided identifier name.

Enumerations

Enumeration Description
DialogItem Each DialogItem represents an item in a BookmarkDialog dialog box.

Example

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

[C#]
BookmarkDialog dlg = new BookmarkDialog(textControl1);
dlg.ShowDialog();
[Visual Basic]
Dim dlg As New BookmarkDialog(textControl1)
dlg.ShowDialog()

See Also