CommentsDialog Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.Windows. Forms. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.Windows. Forms. dll
- Inherits
- Form
- Comments
Dialog
Description
The CommentsDialog class implements a dialog box that shows all comments of the document. Each of these elements can be selected to move the current input position to the corresponding commented text and handle the related comment by deleting, replying to or editing it. The dialog can be opened as a modeless dialog box. Each item of the dialog box has a name, available through its Name property, which corresponds with a member of the CommentsDialog.DialogItem enumeration. The CommentsDialog.FindItem method can be used to get a certain item and manipulate, move or delete it. The CommentsDialog is a modeless dialog box which must be shown with the CommentsDialog.Show method.
Syntax
public class CommentsDialog : FormPublic Class CommentsDialog
Inherits FormExamples
The following example creates a CommentsDialog object and shows the dialog box:
CommentsDialog dlg = new CommentsDialog(textControl1);
dlg.Show();Dim dlg As New CommentsDialog(textControl1)
dlg.Show()The following example creates a Comments Dialog instance and configures its allow transparency setting for a document workflow.
using CommentsDialog commentsDialog = new(new TextControl());
commentsDialog.AllowTransparency = true;Dim commentsDialog As New CommentsDialog(New TextControl())
commentsDialog.AllowTransparency = TrueMembers
Constructors
| Constructor | Description |
|---|---|
| CommentsDialog | Creates a CommentsDialog 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 CommentsDialog 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 CommentsDialog.FindItem method to get the item and manipulate it. |