Skip to content

workbookcomment.md

Latest commit

 

History

History
78 lines (61 loc) · 2.89 KB

workbookcomment.md

File metadata and controls

78 lines (61 loc) · 2.89 KB
title workbookComment resource type
description Represents a comment in a workbook.
ms.localizationpriority medium
author AmandaHan123
ms.subservice excel
doc_type resourcePageType
toc.title Comment
ms.date 09/05/2025

workbookComment resource type

Namespace: microsoft.graph

Represents a comment in a workbook.

Methods

Method Return Type Description
List workbookComment collection Get a workbookComment object collection.
Create workbookComment Create a new workbookComment object.
Get workbookComment Read the properties and relationships of a workbookComment object.

Properties

Property Type Description
cellAddress String The cell where the comment is located. The address value is in A1-style, which contains the sheet reference (for example, Sheet1!A1). Read-only.
content String The content of the comment that is the String displayed to end-users.
contentType String The content type of the comment. Supported values are: plain, mention.
id String The unique identifier of the comment. Read-only.
mentions workbookCommentMention collection A collection that contains all the people mentioned within the comment. When contentType is plain, this property is an empty array. Read-only.
richContent String The rich content of the comment (for example, comment content with mentions, where the first mentioned entity has an ID attribute of 0 and the second has an ID attribute of 1). When contentType is plain, this property is empty. Read-only.

Relationships

Relationship Type Description
replies workbookCommentReply collection The list of replies to the comment. Read-only. Nullable.
task workbookDocumentTask The task associated with the comment. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "cellAddress": "String",
  "content": "String",
  "contentType": "String",
  "id": "String (identifier)",
  "mentions": [{ "@odata.type": "microsoft.graph.workbookCommentMention" }],
  "richContent": "String"
}