CommentRunCollection Interface

A collection of comment text regions, each formatted with its own font.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

public interface CommentRunCollection :
    ISimpleCollection<CommentRun>,
    IEnumerable<CommentRun>,
    IEnumerable,
    ICollection

VB.NET

Public Interface CommentRunCollection
    Inherits ISimpleCollection(Of CommentRun),
             IEnumerable(Of CommentRun),
             IEnumerable,
             ICollection

Related API Members

The following members return CommentRunCollection objects:

• Comment.Runs

Remarks

Comment text is grouped into one or more runs. Each run is specified by the CommentRun object and defines a region of the comment text (CommentRun.Text) with its own set of font characteristics (CommentRun.Font). The Comment.Runs property returns the CommentRunCollection collection that stores comment runs. Use methods of the CommentRunCollection object to divide the comment text into regions and specify font properties for each text region.

Important

The WinForms and WPF Spreadsheet controls do not support rich text within a comment at present. Rich format settings, however, are saved to a file, so you can use another spreadsheet application that can display rich text (e.g., Microsoft® Excel®) to view such comments.

Example

This example demonstrates how to add a comment to a cell and format the comment text.

1. To create a new comment and associate it with a cell, access the worksheet’s collection of cell comments from the Worksheet.Comments property and call the CommentCollection.Add method. Pass the following parameters:

   • a Cell object that specifies the cell to be commented;
   • a string that specifies the author of the comment. In this example, the system username is used. Access it from the Workbook.CurrentAuthor property;
   • a string that specifies the text of the comment.

2. To apply different fonts to specific regions of the comment text, modify the CommentRunCollection collection, which is accessed from the Comment.Runs property. This collection stores the CommentRun objects (comment runs) that define regions of the comment text that are formatted specifically. After a comment has been created, its text is defined by a single run that is contained in the CommentRunCollection collection.

   Add more runs to the comment.

   • Insert the author’s name at the beginning of the comment text (using the CommentRunCollection.Insert method) and format it as bold.
   • Access the comment text that was added initially. It is now defined by the second run in the collection of the comment runs. Modify font characteristics for this text region.
   • Add one more run to the end of the comment text using the CommentRunCollection.Add method.

As you can see, cell comments can be formatted using methods of the CommentRunCollection object.

To remove comments from cells, use the CommentCollection.Remove, CommentCollection.RemoveAt, CommentCollection.Clear or Worksheet.ClearComments methods.

C#

using DevExpress.Spreadsheet;
//...

Workbook workbook = new Workbook();
Worksheet worksheet = workbook.Worksheets[0];

//Get the system username. 
string author = workbook.CurrentAuthor;

//Add a comment to the A1 cell.
Cell cell = worksheet.Cells["A1"];
Comment comment = worksheet.Comments.Add(cell, author, "This is important information for users.");

//Add the author name at the beginning of the comment.
CommentRunCollection runs = comment.Runs;
runs.Insert(0, author + ": \r\n");
runs[0].Font.Bold = true;

//Format the comment text.
runs[1].Font.Color = Color.Red;
runs[1].Font.Name = "Times New Roman";
runs[1].Font.Size = 14;
runs[1].Font.Italic = true;

//Add a new comment run. 
runs.Add("\n Never delete this comment!");
runs[2].Font.Color = Color.MidnightBlue;

VB.NET

Imports DevExpress.Spreadsheet
'...

Dim workbook As New Workbook()
Dim worksheet As Worksheet = workbook.Worksheets(0)

'Get the system username. 
Dim author As String = workbook.CurrentAuthor

'Add a comment to the A1 cell.
Dim cell As Cell = worksheet.Cells("A1")
Dim comment As Comment = worksheet.Comments.Add(cell, author, "This is important information for users.")

'Add the author name at the beginning of the comment.
Dim runs As CommentRunCollection = comment.Runs
runs.Insert(0, author & ": " & Constants.vbCrLf)
runs(0).Font.Bold = True

'Format the comment text.
runs(1).Font.Color = Color.Red
runs(1).Font.Name = "Times New Roman"
runs(1).Font.Size = 14
runs(1).Font.Italic = True

'Add a new comment run. 
runs.Add(Constants.vbLf & "Never delete this comment!")
runs(2).Font.Color = Color.MidnightBlue