Back to Devexpress

CommentCollection.GetComments(CellRange) Method

officefileapi-devexpress-dot-spreadsheet-dot-commentcollection-dot-getcomments-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md

latest4.1 KB
Original Source

CommentCollection.GetComments(CellRange) Method

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

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
List<Comment> GetComments(
    CellRange range
)
vb
Function GetComments(
    range As CellRange
) As List(Of Comment)

Parameters

NameTypeDescription
rangeCellRange

A cell range that contains notes to be returned.

|

Returns

TypeDescription
List<Comment>

A collection of notes within the specified range of cells.

|

Remarks

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

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.

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

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

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

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

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

vb
' 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#L232

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

See Also

CommentCollection Interface

CommentCollection Members

DevExpress.Spreadsheet Namespace