Excel.ConditionalFormat class

Пакет:

excel

Объект, инкапсулирующий диапазон, формат, правило и другие свойства условного форматирования. Дополнительные сведения об объектной модели условного форматирования см. в статье Применение условного форматирования к диапазонам Excel.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.6

Используется

• Excel.ConditionalFormatCollection: add, getItem, getItemAt, getItemOrNullObject, items

Свойства

cellValue	Возвращает значение ячейки: свойства условного формата, если текущим условным форматированием является тип.CellValue
cellValueOrNullObject	Возвращает значение ячейки: свойства условного формата, если текущим условным форматированием является тип.CellValue
colorScale	Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип.ColorScale
colorScaleOrNullObject	Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип.ColorScale
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
custom	Возвращает свойства настраиваемого условного форматирования, если текущий условный формат имеет пользовательский тип.
customOrNullObject	Возвращает свойства настраиваемого условного форматирования, если текущий условный формат имеет пользовательский тип.
dataBar	Возвращает свойства гистограммы, если текущий условный формат является гистограммой.
dataBarOrNullObject	Возвращает свойства гистограммы, если текущий условный формат является гистограммой.
iconSet	Возвращает свойства условного форматирования набора значков, если текущим условным форматированием является тип.IconSet
iconSetOrNullObject	Возвращает свойства условного форматирования набора значков, если текущим условным форматированием является тип.IconSet
id	Приоритет условного формата в текущем ConditionalFormatCollectionформате
preset	Возвращает заданные условия условного форматирования. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.
presetOrNullObject	Возвращает заданные условия условного форматирования. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.
priority	Приоритет (или индекс) в коллекции условного форматирования, в которой это условное форматирование существует в настоящее время. Это также меняет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начинать с конца. Приоритеты больше этих границ будут устанавливаться на максимальный (или минимальный, если отрицательный) приоритет. Также обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении, если вы хотите внести в него дальнейшие изменения.
stopIfTrue	Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение указано null на гистограммах, наборах значков и цветовых шкалах, так как для них не существует понятия StopIfTrue .
textComparison	Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип. Например, для форматирования ячеек, соответствующих слову "Текст".
textComparisonOrNullObject	Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип. Например, для форматирования ячеек, соответствующих слову "Текст".
topBottom	Возвращает первые и последние свойства условного форматирования, если текущий условный формат является типом TopBottom . Например, можно отформатировать первые 10 % или последние 10 элементов.
topBottomOrNullObject	Возвращает первые и последние свойства условного форматирования, если текущий условный формат является типом TopBottom . Например, можно отформатировать первые 10 % или последние 10 элементов.
type	Разновидность условного форматирования. Одновременно можно установить только один вариант.

Методы

changeRuleToCellValue(properties)	Измените тип правила условного форматирования на значение ячейки.
changeRuleToColorScale()	Измените тип правила условного форматирования на цветовую шкалу.
changeRuleToContainsText(properties)	Измените тип правила условного форматирования на сравнение текста.
changeRuleToCustom(formula)	Измените тип правила условного форматирования на настраиваемый.
changeRuleToDataBar()	Измените тип правила условного форматирования на гистограмму.
changeRuleToIconSet()	Измените тип правила условного форматирования на набор значков.
changeRuleToPresetCriteria(properties)	Измените тип правила условного форматирования на заранее заданные условия.
changeRuleToTopBottom(properties)	Измените тип правила условного форматирования на "верхний/нижний".
delete()	Удаляет это условное форматирование.
getRange()	Возврат диапазона, к которому применено условное форматирование. Выдает ошибку, если условное форматирование применяется к нескольким диапазонам.
getRangeOrNullObject()	Возвращает диапазон, к которому применено условное форматирование. Если условное форматирование применяется к нескольким диапазонам, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRanges()	Возвращает RangeAreasзначение , состоящее из одного или нескольких прямоугольных диапазонов, к которым применяется условное форматирование.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setRanges(ranges)	Установите диапазоны, к которым применяется правило условного форматирования.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ConditionalFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ConditionalFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

cellValue

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

readonly cellValue: Excel.CellValueConditionalFormat;

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

Excel.CellValueConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B21:E23");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.cellValue);
    conditionalFormat.cellValue.format.font.color = "red";
    conditionalFormat.cellValue.rule = { 
        formula1: "=0",
        operator: Excel.ConditionalCellValueOperator.lessThan
    };

    await context.sync();
});

cellValueOrNullObject

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

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

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

Excel.CellValueConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

colorScale

Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип.ColorScale

readonly colorScale: Excel.ColorScaleConditionalFormat;

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

Excel.ColorScaleConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.colorScale);
    const 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();
});

colorScaleOrNullObject

Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип.ColorScale

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

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

Excel.ColorScaleConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

context

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

context: RequestContext;

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

Excel.RequestContext

custom

Возвращает свойства настраиваемого условного форматирования, если текущий условный формат имеет пользовательский тип.

readonly custom: Excel.CustomConditionalFormat;

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

Excel.CustomConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
    conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
    conditionalFormat.custom.format.font.color = "green";

    await context.sync();
});

customOrNullObject

Возвращает свойства настраиваемого условного форматирования, если текущий условный формат имеет пользовательский тип.

readonly customOrNullObject: Excel.CustomConditionalFormat;

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

Excel.CustomConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

dataBar

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

readonly dataBar: Excel.DataBarConditionalFormat;

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

Excel.DataBarConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

dataBarOrNullObject

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

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

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

Excel.DataBarConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

iconSet

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

readonly iconSet: Excel.IconSetConditionalFormat;

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

Excel.IconSetConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.iconSet);
    const iconSetCF = conditionalFormat.iconSet;
    iconSetCF.style = Excel.IconSet.threeTriangles;

    /*
        The iconSetCF.criteria array is automatically prepopulated with
        criterion elements whose properties have been given default settings.
        You can't write to each property of a criterion directly. Instead,
        replace the whole criteria object.

        With a "three*" icon set style, such as "threeTriangles", the third
        element in the criteria array (criteria[2]) defines the "top" icon;
        e.g., a green triangle. The second (criteria[1]) defines the "middle"
        icon. The first (criteria[0]) defines the "low" icon, but it
        can often be left empty as the following object shows, because every
        cell that does not match the other two criteria always gets the low
        icon.            
    */
    
    const lowIcon: Excel.Icon = {
        set: Excel.IconSet.threeFlags,
        index: 0
    };

    iconSetCF.criteria = [
        {
            customIcon: lowIcon
        } as Excel.ConditionalIconCriterion,
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=700"
        },
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=1000",
        }
    ];
    await context.sync();
});

iconSetOrNullObject

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

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

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

Excel.IconSetConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

id

Приоритет условного формата в текущем ConditionalFormatCollectionформате

readonly id: string;

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

string

Комментарии

Набор API: ExcelApi 1.6

preset

Возвращает заданные условия условного форматирования. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.

readonly preset: Excel.PresetCriteriaConditionalFormat;

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

Excel.PresetCriteriaConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.presetCriteria);
    conditionalFormat.preset.format.font.color = "white";
    conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };

    await context.sync();
});

presetOrNullObject

Возвращает заданные условия условного форматирования. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

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

Excel.PresetCriteriaConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

priority

Приоритет (или индекс) в коллекции условного форматирования, в которой это условное форматирование существует в настоящее время. Это также меняет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начинать с конца. Приоритеты больше этих границ будут устанавливаться на максимальный (или минимальный, если отрицательный) приоритет. Также обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении, если вы хотите внести в него дальнейшие изменения.

priority: number;

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

number

Комментарии

Набор API: ExcelApi 1.6

stopIfTrue

Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение указано null на гистограммах, наборах значков и цветовых шкалах, так как для них не существует понятия StopIfTrue .

stopIfTrue: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.6

textComparison

Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип. Например, для форматирования ячеек, соответствующих слову "Текст".

readonly textComparison: Excel.TextConditionalFormat;

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

Excel.TextConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B16:D18");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.containsText);
    conditionalFormat.textComparison.format.font.color = "red";
    conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" };

    await context.sync();
});

textComparisonOrNullObject

Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип. Например, для форматирования ячеек, соответствующих слову "Текст".

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

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

Excel.TextConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

topBottom

Возвращает первые и последние свойства условного форматирования, если текущий условный формат является типом TopBottom . Например, можно отформатировать первые 10 % или последние 10 элементов.

readonly topBottom: Excel.TopBottomConditionalFormat;

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

Excel.TopBottomConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

topBottomOrNullObject

Возвращает первые и последние свойства условного форматирования, если текущий условный формат является типом TopBottom . Например, можно отформатировать первые 10 % или последние 10 элементов.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

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

Excel.TopBottomConditionalFormat

Комментарии

Набор API: ExcelApi 1.6

type

Разновидность условного форматирования. Одновременно можно установить только один вариант.

readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

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

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

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

changeRuleToCellValue(properties)

Измените тип правила условного форматирования на значение ячейки.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Параметры

properties

Excel.ConditionalCellValueRule

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

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToColorScale()

Измените тип правила условного форматирования на цветовую шкалу.

changeRuleToColorScale(): void;

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToContainsText(properties)

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

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Параметры

properties

Excel.ConditionalTextComparisonRule

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

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToCustom(formula)

Измените тип правила условного форматирования на настраиваемый.

changeRuleToCustom(formula: string): void;

Параметры

formula

string

Формула, задаваемая для настраиваемого правила условного форматирования.

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToDataBar()

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

changeRuleToDataBar(): void;

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToIconSet()

Измените тип правила условного форматирования на набор значков.

changeRuleToIconSet(): void;

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToPresetCriteria(properties)

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

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Параметры

properties

Excel.ConditionalPresetCriteriaRule

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

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

void

Комментарии

Набор API: ExcelApi 1.17

changeRuleToTopBottom(properties)

Измените тип правила условного форматирования на "верхний/нижний".

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Параметры

properties

Excel.ConditionalTopBottomRule

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

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

void

Комментарии

Набор API: ExcelApi 1.17

delete()

Удаляет это условное форматирование.

delete(): void;

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

void

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const temperatureDataRange = sheet.tables.getItem("TemperatureTable").getDataBodyRange();
    temperatureDataRange.conditionalFormats.getItemAt(0).delete();

    await context.sync();
});

getRange()

Возврат диапазона, к которому применено условное форматирование. Выдает ошибку, если условное форматирование применяется к нескольким диапазонам.

getRange(): Excel.Range;

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

getRangeOrNullObject()

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

getRangeOrNullObject(): Excel.Range;

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.6

getRanges()

Возвращает RangeAreasзначение , состоящее из одного или нескольких прямоугольных диапазонов, к которым применяется условное форматирование.

getRanges(): Excel.RangeAreas;

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

load(options)

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

load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Параметры

options

Excel.Interfaces.ConditionalFormatLoadOptions

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

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

Excel.ConditionalFormat

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ConditionalFormat

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalFormat;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

Excel.ConditionalFormat

set(properties, options)

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

set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.ConditionalFormatUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ConditionalFormat): void;

Параметры

properties

Excel.ConditionalFormat

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

void

setRanges(ranges)

Установите диапазоны, к которым применяется правило условного форматирования.

setRanges(ranges: Range | RangeAreas | string): void;

Параметры

ranges

Excel.Range | Excel.RangeAreas | string

Коллекция одного или нескольких диапазонов для применения этого правила.

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

void

Комментарии

Набор API: ExcelApi 1.17

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalFormatData;

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

Excel.Interfaces.ConditionalFormatData