Excel.NoteCollection class
表示属于工作簿的注释对象的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(cell |
在给定单元格上添加具有给定内容的新注释。 |
| get |
获取集合中的注释数。 |
| get |
按单元格地址获取笔记。 |
| get |
根据集合的位置从集合中获取注释。 |
| get |
按单元格地址获取笔记。 如果 note 对象不存在，则此方法返回一个 对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
add(cellAddress, content)
在给定单元格上添加具有给定内容的新注释。
add(cellAddress: Range | string, content: any): Excel.Note;参数
- cellAddress
-
Excel.Range | string
要向其添加注释的单元格。 这可以是 Range 对象或字符串，例如“A1”。 如果字符串无效，或者区域不是单个单元格， InvalidCellAddress 则会引发错误。
- content
-
any
注释的文本。
返回
注解
getCount()
获取集合中的注释数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(key)
按单元格地址获取笔记。
getItem(key: string): Excel.Note;参数
- key
-
string
注释的单元格地址。
返回
具有给定单元格地址的注释。 如果给定单元格地址没有注释，则会 ItemNotFound 引发错误。
注解
getItemAt(index)
根据集合的位置从集合中获取注释。
getItemAt(index: number): Excel.Note;参数
- index
-
number
要检索的注释的索引值。 从零开始编制索引。
返回
注解
getItemOrNullObject(key)
按单元格地址获取笔记。 如果 note 对象不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.Note;参数
- key
-
string
注释的单元格地址。
返回
具有给定单元格地址或 null 对象的注释。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.NoteCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.NoteCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.NoteCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.NoteCollectionData;