Excel.Comment class

包:

excel

表示工作簿中的注释。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.10 ]

属性

authorEmail	获取批注作者的电子邮件。
authorName	获取批注作者的姓名。
content	批注的内容。 字符串为纯文本。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
creationDate	获取批注的创建时间。 null如果注释是从笔记转换的，则返回 ，因为注释没有创建日期。
id	指定注释标识符。
replies	表示与批注关联的回复对象的集合。

方法

delete()	删除批注和所有已连接的回复。
getLocation()	获取此注释所在的单元格。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.Comment 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.CommentData) ，该对象包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

authorEmail

获取批注作者的电子邮件。

readonly authorEmail: string;

属性值

string

注解

[ API 集：ExcelApi 1.10 ]

authorName

获取批注作者的姓名。

readonly authorName: string;

属性值

string

注解

[ API 集：ExcelApi 1.10 ]

content

批注的内容。 字符串为纯文本。

content: string;

属性值

string

注解

[ API 集：ExcelApi 1.10 ]

示例

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

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

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

creationDate

获取批注的创建时间。 null如果注释是从笔记转换的，则返回 ，因为注释没有创建日期。

readonly creationDate: Date;

属性值

Date

注解

[ API 集：ExcelApi 1.10 ]

id

指定注释标识符。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi 1.10 ]

replies

表示与批注关联的回复对象的集合。

readonly replies: Excel.CommentReplyCollection;

属性值

Excel.CommentReplyCollection

注解

[ API 集：ExcelApi 1.10 ]

方法详细信息

delete()

删除批注和所有已连接的回复。

delete(): void;

返回

void

注解

[ API 集：ExcelApi 1.10 ]

示例

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

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

getLocation()

获取此注释所在的单元格。

getLocation(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.10 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

options

Excel.Interfaces.CommentLoadOptions

提供要加载对象的属性的选项。

返回

Excel.Comment

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.Comment

示例

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

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();
});

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.Comment

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

properties

Excel.Interfaces.CommentUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.Comment): void;

参数

properties

Excel.Comment

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.Comment 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.CommentData) ，该对象包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.CommentData;

返回

Excel.Interfaces.CommentData