TX Text Control .NET for Windows Forms

BookmarkDialog 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. BookmarkDialog

Description

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.

Syntax

public class BookmarkDialog : Form

Examples

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

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

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

using BookmarkDialog bookmarkDialog = new(new TextControl());
bookmarkDialog.AllowTransparency = true;

Members

Constructors

ConstructorDescription
BookmarkDialogCreates a BookmarkDialog 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_BookmarkNameNot described in the reference. public TextBox TXITEM_BookmarkName;
TXITEM_BookmarkNameLabelNot described in the reference. public Label TXITEM_BookmarkNameLabel;
TXITEM_CancelNot described in the reference. public System.Windows.Forms.Button TXITEM_Cancel;
TXITEM_DeletableNot described in the reference. public CheckBox TXITEM_Deletable;
TXITEM_OKNot described in the reference. public System.Windows.Forms.Button TXITEM_OK;

Enumerations

EnumerationDescription
DialogItemEach DialogItem represents an item in a BookmarkDialog 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 BookmarkDialog.FindItem method to get the item and manipulate it.