Поделиться через


Excel.CustomPropertyCollection class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

context

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

items

Получает загруженные дочерние элементы в этой коллекции.

Методы

add(key, value)

Создает или задает настраиваемое свойство.

deleteAll()

Удаляет все настраиваемые свойства в коллекции.

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.CustomPropertyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CustomPropertyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

Сведения о свойстве

context

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

context: RequestContext;

Значение свойства

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.CustomProperty[];

Значение свойства

Сведения о методе

add(key, value)

Создает или задает настраиваемое свойство.

add(key: string, value: any): Excel.CustomProperty;

Параметры

key

string

Обязательно. Ключ настраиваемого свойства, который не учитывает регистр. Клавиша ограничена 255 символами за пределами Excel в Интернете (более крупные клавиши автоматически обрезаются до 255 символов на других платформах).

value

any

Обязательно. Значение настраиваемого свойства. Значение ограничено 255 символами за пределами Excel в Интернете (на других платформах значения большего размера автоматически обрезаются до 255 символов).

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// 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 customDocProperties = context.workbook.properties.custom;
  customDocProperties.add(userKey, userValue);

  await context.sync();

  console.log(`Successfully set custom document property ${userKey}:${userValue}.`);
});

deleteAll()

Удаляет все настраиваемые свойства в коллекции.

deleteAll(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

getCount()

Получает количество настраиваемых свойств.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.7 ]

getItem(key)

Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку, если пользовательское свойство не существует.

getItem(key: string): Excel.CustomProperty;

Параметры

key

string

Ключ, идентифицирующий объект пользовательского свойства.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.7 ]

getItemOrNullObject(key)

Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(key: string): Excel.CustomProperty;

Параметры

key

string

Обязательно. Ключ, идентифицирующий объект пользовательского свойства.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.7 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;

Параметры

options

Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.CustomPropertyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CustomPropertyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.CustomPropertyCollectionData;

Возвращаемое значение