Excel.CustomPropertyCollection interface

Содержит коллекцию объектов customProperty.

Методы

add(key, value)

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

deleteAll()

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

getCount()

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

getItem(key)

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

getItemOrNullObject(key)

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

load(propertyNames)

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

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

add(key, value)

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

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

Параметры

key
string

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

value
any

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

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

deleteAll()

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

deleteAll(): void;

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

void

getCount()

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

getCount(): ClientResult<number>;

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

ClientResult<number>

getItem(key)

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

getItem(key: string): CustomProperty;

Параметры

key
string

Ключ, который определяет объект настраиваемого свойства.

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

getItemOrNullObject(key)

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

getItemOrNullObject(key: string): CustomProperty;

Параметры

key
string

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

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void