Excel.WorksheetCustomPropertyCollection class

Пакет:

excel

Содержит коллекцию настраиваемого свойства на уровне листа.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.12 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(key, value)	Добавляет новое пользовательское свойство, которое сопоставляется с предоставленным ключом. При этом существующие настраиваемые свойства перезаписываются этим ключом.
getCount()	Возвращает количество настраиваемых свойств на этом листе.
getItem(key)	Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку, если пользовательское свойство не существует.
getItemOrNullObject(key)	Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *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)

Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *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