CommentCollection.GetComments(CellRange) Method

Gets the comment(s) contained in the specified cell range.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

List<Comment> GetComments(
    CellRange range
)

VB.NET

Function GetComments(
    range As CellRange
) As List(Of Comment)

Parameters

Name	Type	Description
range	CellRange	A CellRange object specifying a cell range that contains comments to be returned.

Returns

Type	Description
List<Comment>	A collection of comments within the specified range of cells.

Remarks

The GetComments method returns all comments contained in cell ranges that intersect the specified cell range. To check whether a comment is contained in the worksheet, use the CommentCollection.Contains method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetComments(CellRange) method.

Note

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.

C#

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/CellActions.cs#L391

// Get the added comment and make it visible.
Comment commentE2 = worksheet.Comments.GetComments(worksheet["E2"])[0];
commentE2.Visible = true;

winforms-spreadsheetcontrol-api-part1/CS/SpreadsheetControl/SpreadsheetActions/CellActions.cs#L431

// Get the added comment and make it visible.
Comment commentE2 = worksheet.Comments.GetComments(worksheet["E2"])[0];
commentE2.Visible = true;

VB.NET

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/CellActions.vb#L382

' Get the added comment and make it visible.
Dim commentE2 As Comment = worksheet.Comments.GetComments(worksheet("E2"))(0)
commentE2.Visible = True

winforms-spreadsheetcontrol-api-part1/VB/SpreadsheetControl/SpreadsheetActions/CellActions.vb#L425

' Get the added comment and make it visible.
Dim commentE2 As Comment = worksheet.Comments.GetComments(worksheet("E2"))(0)
commentE2.Visible = True

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/CellActions.vb#L210

worksheet.ClearComments(worksheet("C6"))
Dim commentD6 As Comment = worksheet.Comments.GetComments(worksheet("D6"))(0)
worksheet.Comments.Remove(commentD6)