Excel.CommentReply class

Represents a comment reply in the workbook.

Extends

Remarks

[ API set: ExcelApi 1.10 ]

Properties

authorEmail

Gets the email of the comment reply's author.

authorName

Gets the name of the comment reply's author.

content

The comment reply's content. The string is plain text.

contentType

The content type of the reply.

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 reply.

id

Specifies the comment reply identifier.

mentions

The entities (e.g., people) that are mentioned in comments.

resolved

The comment reply status. A value of true means the reply is in the resolved state.

richContent

The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content.

Methods

delete()

Deletes the comment reply.

getLocation()

Gets the cell where this comment reply is located.

getParentComment()

Gets the parent comment of this reply.

load(options)

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.CommentReply object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentReplyData) that contains shallow copies of any loaded child properties from the original object.

updateMentions(contentWithMentions)

Updates the comment content with a specially formatted string and a list of mentions.

Property Details

authorEmail

Gets the email of the comment reply's author.

readonly authorEmail: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

authorName

Gets the name of the comment reply's author.

readonly authorName: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

content

The comment reply's content. The string is plain text.

content: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    const reply = comment.replies.getItemAt(0);
    reply.load("content");
    // Sync to load the content of the comment reply.
    await context.sync();

    // Append "Please!" to the end of the comment reply.
    reply.content += " Please!";
    await context.sync();
});

contentType

The content type of the reply.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

Property Value

Excel.ContentType | "Plain" | "Mention"

Remarks

[ API set: ExcelApi 1.12 ]

context

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

Gets the creation time of the comment reply.

readonly creationDate: Date;

Property Value

Date

Remarks

[ API set: ExcelApi 1.10 ]

id

Specifies the comment reply identifier.

readonly id: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

mentions

The entities (e.g., people) that are mentioned in comments.

readonly mentions: Excel.CommentMention[];

Property Value

Remarks

[ API set: ExcelApi 1.11 ]

resolved

The comment reply status. A value of true means the reply is in the resolved state.

readonly resolved: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]

richContent

The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content.

readonly richContent: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.11 ]

Method Details

delete()

Deletes the comment reply.

delete(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.10 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml

await Excel.run(async (context) => {
    // Remove the first comment reply from this worksheet's first comment.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.replies.getItemAt(0).delete();
    await context.sync();
});

getLocation()

Gets the cell where this comment reply is located.

getLocation(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.10 ]

getParentComment()

Gets the parent comment of this reply.

getParentComment(): Excel.Comment;

Returns

Remarks

[ API set: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;

Parameters

options
Excel.Interfaces.CommentReplyLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

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.CommentReply;

Parameters

propertyNames

string | string[]

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

Returns

load(propertyNamesAndPaths)

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.CommentReply;

Parameters

propertyNamesAndPaths

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

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

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: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.CommentReplyUpdateData

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

set(properties)

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

set(properties: Excel.CommentReply): void;

Parameters

properties
Excel.CommentReply

Returns

void

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.CommentReply object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentReplyData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.CommentReplyData;

Returns

updateMentions(contentWithMentions)

Updates the comment content with a specially formatted string and a list of mentions.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Parameters

contentWithMentions
Excel.CommentRichContent

The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel.

Returns

void

Remarks

[ API set: ExcelApi 1.11 ]