Related API Members
The following members accept/return Comment objects:
|Library||Related API Members|
|Office File API||CommentCollection.Add(CellRange, String)|
|CommentCollection.Add(CellRange, String, String)|
An object exposing the Comment interface can be accessed as an item of the collection obtained via the Worksheet.Comments property.
This example demonstrates how to add a comment to a cell and format the comment text.
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:
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.
using DevExpress.Spreadsheet; //... Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets; //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.Font.Bold = true; //Format the comment text. runs.Font.Color = Color.Red; runs.Font.Name = "Times New Roman"; runs.Font.Size = 14; runs.Font.Italic = true; //Add a new comment run. runs.Add("\n Never delete this comment!"); runs.Font.Color = Color.MidnightBlue;
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the Comment interface.
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.