Excel.Comment class

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a cell comment object in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Extends
OfficeExtension.ClientObject

Properties

authorEmail

Gets the email of the comment's author.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

authorName

Gets the name of the comment's author.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

content

Gets or sets the comment's content. The string is plain text.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

creationDate

Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id

Represents the comment identifier. Read-only.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

replies

Represents a collection of reply objects associated with the comment. Read-only.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

resolved

Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Methods

delete()

Deletes the comment thread.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getLocation()

Gets the cell where this comment is located.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentData) that contains shallow copies of any loaded child properties from the original object.

Property Details

authorEmail

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the email of the comment's author.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly authorEmail: string;

Property Value

string

authorName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the name of the comment's author.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly authorName: string;

Property Value

string

content

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets or sets the comment's content. The string is plain text.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

content: string;

Property Value

string

Examples

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

creationDate

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly creationDate: Date;

Property Value

Date

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the comment identifier. Read-only.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly id: string;

Property Value

string

replies

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a collection of reply objects associated with the comment. Read-only.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly replies: Excel.CommentReplyCollection;

Property Value

resolved

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

resolved: boolean;

Property Value

boolean

Method Details

delete()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Deletes the comment thread.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

delete(): void;

Returns

void

Examples

await Excel.run(async (context) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

getLocation()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the cell where this comment is located.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getLocation(): Excel.Range;

Returns

load(option)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;

Parameters

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Comment - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Comment - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Comment - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.Comment;

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Comment;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Examples

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

    console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
    await context.sync();
});

set(properties, options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.CommentUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.Comment): void

set(properties)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Comment): void;

Parameters

properties
Excel.Comment

Returns

void

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.CommentData;

Returns