Excel.Note class

包:

excel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示工作簿或工作表中的注释。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi BETA (仅预览版) ]

属性

authorName	获取笔记的作者。
content	获取或设置笔记的文本。 字符串必须少于 256 个字符。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
height	指定注释的高度。
visible	指定注释的可见性。 值 表示 true 显示注释。
width	指定注释的宽度。

方法

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.Note对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.NoteData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

authorName

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取笔记的作者。

readonly authorName: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

content

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取或设置笔记的文本。 字符串必须少于 256 个字符。

content: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

context

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

context: RequestContext;

属性值

Excel.RequestContext

height

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定注释的高度。

height: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

visible

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定注释的可见性。 值 表示 true 显示注释。

visible: boolean;

属性值

boolean

注解

[ API 集：ExcelApi BETA (仅预览版) ]

width

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定注释的宽度。

width: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

方法详细信息

delete()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

删除注释。

delete(): void;

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

getLocation()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

getLocation(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi BETA (仅预览版) ]

load(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;

参数

options

Excel.Interfaces.NoteLoadOptions

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

返回

Excel.Note

load(propertyNames)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

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

参数

propertyNames

string | string[]

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

返回

Excel.Note

load(propertyNamesAndPaths)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.Note

set(properties, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

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

参数

properties

Excel.Interfaces.NoteUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

set(properties: Excel.Note): void;

参数

properties

Excel.Note

返回

void

toJSON()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

toJSON(): Excel.Interfaces.NoteData;

返回

Excel.Interfaces.NoteData