Excel.WorksheetCustomPropertyCollection class

包:

excel

包含工作表级自定义属性的集合。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.12 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

add(key, value)	添加映射到提供的键的新自定义属性。 这将使用该键覆盖现有自定义属性。
getCount()	获取此工作表上的自定义属性数。
getItem(key)	按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则引发错误。
getItemOrNullObject(key)	按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.WorksheetCustomPropertyCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WorksheetCustomPropertyCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

获取此集合中已加载的子项。

readonly items: Excel.WorksheetCustomProperty[];

属性值

Excel.WorksheetCustomProperty[]

方法详细信息

add(key, value)

添加映射到提供的键的新自定义属性。 这将使用该键覆盖现有自定义属性。

add(key: string, value: string): Excel.WorksheetCustomProperty;

参数

key

string

标识自定义属性对象的键。 它不区分大小写。键限制为 255 个字符， (较大的值将导致 InvalidArgument 引发错误。)

value

string

此自定义属性的值。

返回

Excel.WorksheetCustomProperty

注解

[ API 集：ExcelApi 1.12 ]

示例

// 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 = $("#key").text();
  const userValue = $("#value").text();

  // 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>

注解

[ API 集：ExcelApi 1.12 ]

getItem(key)

按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则引发错误。

getItem(key: string): Excel.WorksheetCustomProperty;

参数

key

string

标识自定义属性对象的键。 它不区分大小写。

返回

Excel.WorksheetCustomProperty

注解

[ API 集：ExcelApi 1.12 ]

getItemOrNullObject(key)

按键获取自定义属性对象（不区分大小写）。 如果自定义属性不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(key: string): Excel.WorksheetCustomProperty;

参数

key

string

标识自定义属性对象的键。 它不区分大小写。

返回

Excel.WorksheetCustomProperty

注解

[ API 集：ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;

参数

options

Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.WorksheetCustomPropertyCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.WorksheetCustomPropertyCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCustomPropertyCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.WorksheetCustomPropertyCollection

toJSON()

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

toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;

返回

Excel.Interfaces.WorksheetCustomPropertyCollectionData