Excel.SettingCollection interface

Представляет коллекцию объектов параметров, которые являются частью рабочей книги. Область ограничена для каждого файла и надстройки (область задач или контент).

Методы

add(key, value)

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

getCount()

Получает количество параметров в коллекции.

getItem(key)

Получает запись Setting по ключу.

getItemOrNullObject(key)

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

load(propertyNames)

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

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

add(key, value)

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

add(
            key: string,
            value: string | number | boolean | Date | Array<any> | any
        ): Setting;

Параметры

key
string

Ключ нового параметра.

value
string | number | boolean | Date | Array<any> | any

Значение нового параметра.

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

getCount()

Получает количество параметров в коллекции.

getCount(): ClientResult<number>;

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

ClientResult<number>

getItem(key)

Получает запись Setting по ключу.

getItem(key: string): Setting;

Параметры

key
string

Ключ параметра.

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

getItemOrNullObject(key)

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

getItemOrNullObject(key: string): Setting;

Параметры

key
string

Ключ параметра.

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

Примеры

async function main(context: Excel.RequestContext) {
    let settings = context.workbook.settings;
    let needsReview = settings.getItem("NeedsReview");
    needsReview.delete();
    needsReview = settings.getItemOrNullObject("NeedsReview");

    await context.sync();

    if (needsReview.isNullObject) {
        console.log("The setting has been deleted");
    } else {
        console.log("The setting was not deleted");
    }

    await context.sync();
}

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

void