Excel.ConditionalFormatCollection interface

Представляет коллекцию всех условных форматов, которые перекрывают диапазон.

Методы

add(type)

Добавляет новое условное форматирование в коллекцию по первому или верхнему приоритету.

clearAll()

Полное удаление условного форматирование в указанном диапазоне.

getCount()

Возвращает число условных форматов в книге.

getItem(id)

Возвращает условное форматирование для указанного идентификатора.

getItemAt(index)

Возвращает условное форматирование по индексу.

load(propertyNames)

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

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

add(type)

Добавляет новое условное форматирование в коллекцию по первому или верхнему приоритету.

add(
            type:
                | ConditionalFormatType
                | "Custom"
                | "DataBar"
                | "ColorScale"
                | "IconSet"
                | "TopBottom"
                | "PresetCriteria"
                | "ContainsText"
                | "CellValue"
        ): ConditionalFormat;

Параметры

type
| ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Тип добавляемого условного форматирования. Дополнительные сведения см. в статье Excel. Кондитионалформаттипе.

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

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("B2:M5");
    let conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.colorScale);
    let criteria = {
        minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
        midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
        maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
    };
    conditionalFormat.colorScale.criteria = criteria;

    await context.sync();
}

clearAll()

Полное удаление условного форматирование в указанном диапазоне.

clearAll(): void;

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

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange();
    range.conditionalFormats.clearAll();

    await context.sync();

    $(".conditional-formats").hide();
}

getCount()

Возвращает число условных форматов в книге.

getCount(): ClientResult<number>;

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

ClientResult<number>

getItem(id)

Возвращает условное форматирование для указанного идентификатора.

getItem(id: string): ConditionalFormat;

Параметры

id
string

Идентификатор условного форматирования.

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

getItemAt(index)

Возвращает условное форматирование по индексу.

getItemAt(index: number): ConditionalFormat;

Параметры

index
number

Индекс условных форматов, которые необходимо получить.

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

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

void