officefileapi-devexpress-dot-spreadsheet-dot-commentcollection-dot-add-x28-devexpress-dot-spreadsheet-dot-cellrange-system-dot-string-x29.md
Adds an empty simple note to the specified cell and returns the newly created object.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
Comment Add(
CellRange range,
string author
)
Function Add(
range As CellRange,
author As String
) As Comment
| Name | Type | Description |
|---|---|---|
| range | CellRange |
A cell to which a note is added. If you pass a range of cells, the note is added to the top-left cell in a range.
| | author | String |
A name of the note author. This value is assigned to the Comment.Author property.
|
| Type | Description |
|---|---|
| Comment |
A Comment object that specifies the created note.
|
To specify the note text, use the Text property.
Note
The ThreadedCommentCollection contains threaded comments. Use the Worksheet.ThreadedComments property to retrieve a collection.
This example demonstrates how to add a simple note (a legacy comment) to a cell and format the note text.
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.
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.
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;
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
Use the following methods to remove simple notes:
See Also