CommentRunCollection Interface

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

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

Note text is grouped into one or more runs. Each run is specified by the CommentRun object and defines a region of the note text (CommentRun.Text) with its own set of font characteristics (CommentRun.Font). The Comment.Runs property returns the CommentRunCollection collection that stores these runs. Use methods of the CommentRunCollection object to divide the note 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 note. 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 notes.

Example

This example demonstrates how to add a simple note (a legacy comment) to a cell and format the note text.

Create a Simple Note

To create a new note and associate it with a cell, access the worksheet’s collection of notes from the Worksheet.Comments property and call the CommentCollection.Add method.

Format Note Content

To apply different fonts to specific regions of the comment text, modify the CommentRunCollection collection returned by the Comment.Runs property. This collection stores the CommentRun objects 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.

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

Remove Notes

Use the following methods to remove simple notes:

• CommentCollection.Remove
• CommentCollection.RemoveAt
• CommentCollection.Clear
• Worksheet.ClearComments