Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Collapse]Spreadsheet
   [Expand]Product Information
    Product Structure
    Getting Started
   [Expand]Spreadsheet Document
    Supported Formats
   [Expand]Cell Basics
   [Expand]Spreadsheet Formulas
    Defined Names
    Data Binding
    Data Validation
   [Expand]Data Presentation
    Data Grouping
   [Expand]Pivot Table Overview
   [Expand]Charting Overview
    Printing
    Events
   [Expand]Mail Merge Overview
    Protection
    Find and Replace
   [Expand]Visual Elements
    Services
   [Expand]Shortcuts
   [Collapse]Examples
    [Expand]Files
    [Expand]Workbooks
    [Expand]Worksheets
    [Expand]Rows and Columns
    [Collapse]Cells
      How to: Access a Cell in a Worksheet
      How to: Access a Range of Cells
      How to: Obtain Selected Range and Active Cell
      How to: Insert a Cell or Cell Range
      How to: Delete a Cell or Range of Cells
      How to: Create a Named Range of Cells
      How to: Change a Cell or Cell Range Value
      How to: Convert Objects to Cell Values and Cell Values to Objects
      How to: Add Formulas to Cells
      How to: Add a Hyperlink to a Cell
      How to: Create, Edit and Copy Cell Comments
      How to: Clear Cells of Content, Formatting, Hyperlinks and Comments
      How to: Copy Cell Data Only, Cell Style Only, or Cell Data with Style
      How to: Merge Cells or Split Merged Cells
    [Expand]Formulas
    [Expand]Import and Export Data
    [Expand]Data Binding
    [Expand]Mail Merge
    [Expand]Formatting Cells
    [Expand]Conditional Formatting
    [Expand]Group Data
    [Expand]Filter Data
    [Expand]Tables
    [Expand]Pivot Tables
    [Expand]Printing
    [Expand]Pictures
    [Expand]Charts
    [Expand]Protection
    [Expand]Customization
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

How to: Create, Edit and Copy Cell Comments

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E4655.

This example demonstrates how to create a new comment, edit its text and copy the existing comment to another cell.

  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.

    To make the added comment visible in the cell, set the Comment.Visible property to true.

  2. To edit the comment text, modify the CommentRunCollection collection, which is accessed from the Comment.Runs property. This collection stores the CommentRun objects that define separate regions of the comment text. After a comment is created, its text is defined by a single run that is contained in the CommentRunCollection collection. You can add more runs to the comments, edit the text of the existing runs or completely remove them from the comment.

    Edit the text of the inserted comment by adding the author's name at the beginning of the comment text. To do this, use the CommentRunCollection.Insert method.

  3. To copy the existing comment to another cell, call the Range.CopyFrom method of the Cell object corresponding to the cell into which you wish to insert the copied comment. Pass the source cell and the PasteSpecial.Comments enumerator value to insert only the comment and ignore cell content. The copied comment will replace any existing comment in the destination area.

    Note that the copied comment preserves the structure of the source comment and contains the same number of comment runs. To edit the text of the copied comment, get access to the inserted comment by using the CommentCollection.GetComments method, and then modify the CommentRun.Text property of the second comment run.

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

The image below shows the result.

Expanded See Also

How would you rate this topic?​​​​​​​