Excel.WorksheetCustomPropertyCollection class
包含工作表级自定义属性的集合。
方法
| add(key, value) | 添加映射到所提供键的新自定义属性。 这会使用该键覆盖现有自定义属性。 |
| get |
获取此工作表上的自定义属性数。 |
| get |
按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则引发错误。 |
| get |
按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则此方法将返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
add(key, value)
添加映射到所提供键的新自定义属性。 这会使用该键覆盖现有自定义属性。
add(key: string, value: string): Excel.WorksheetCustomProperty;参数
- key
-
string
标识自定义属性对象的键。 它不区分大小写。该项限制为 255 个字符 (值越大，将导致 InvalidArgument 引发错误。)
- value
-
string
此自定义属性的值。
返回
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Get the key/value pair from the task pane.
const userKey = document.getElementById("key").textContent;
const userValue = document.getElementById("value").textContent;
// Add the custom property.
const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
customWorksheetProperties.add(userKey, userValue);
await context.sync();
console.log(`Successfully set custom worksheet property ${userKey}: ${userValue}.`);
});
getCount()
获取此工作表上的自定义属性数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(key)
按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则引发错误。
getItem(key: string): Excel.WorksheetCustomProperty;参数
- key
-
string
标识自定义属性对象的键。 它不区分大小写。
返回
注解
getItemOrNullObject(key)
按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.WorksheetCustomProperty;参数
- key
-
string
标识自定义属性对象的键。 它不区分大小写。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;参数
- options
-
Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.WorksheetCustomPropertyCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCustomPropertyCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.WorksheetCustomPropertyCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WorksheetCustomPropertyCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;