Excel.ConditionalFormat class

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

readonly cellValue: Excel.CellValueConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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: "LessThan" };

    await context.sync();
});

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

readonly colorScale: Excel.ColorScaleConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

readonly custom: Excel.CustomConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

readonly customOrNullObject: Excel.CustomConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

readonly dataBar: Excel.DataBarConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

readonly iconSet: Excel.IconSetConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Priorité de la mise en forme conditionnelle dans le ConditionalFormatCollectionfichier .

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

readonly preset: Excel.PresetCriteriaConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Priorité (ou index) dans la collection de mise en forme conditionnelle dans laquelle cette mise en forme conditionnelle existe actuellement. La modification de cette option modifie également les priorités des autres formats conditionnels afin de tenir compte d’un ordre de priorité contigu. Utilisez une priorité négative pour commencer par l’arrière. Les priorités supérieures aux limites sont obtenues et définies sur la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer une nouvelle copie de l’objet à ce nouvel emplacement prioritaire si vous souhaitez y apporter d’autres modifications.

priority: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Si les conditions de cette mise en forme conditionnelle sont remplies, aucun format de priorité inférieure ne doit prendre effet sur cette cellule. La valeur se trouve null sur les barres de données, les jeux d’icônes et les échelles de couleurs, car il n’y a pas de concept pour StopIfTrue ceux-ci.

stopIfTrue: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

readonly textComparison: Excel.TextConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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();
});

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

readonly topBottom: Excel.TopBottomConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Type de mise en forme conditionnelle. Un seul peut être défini à la fois.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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.");
    }
});

Modifiez le type de règle de mise en forme conditionnelle par valeur de cellule.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplacer le type de règle de mise en forme conditionnelle par Échelle de couleurs.

changeRuleToColorScale(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplacer le type de règle de mise en forme conditionnelle par comparaison de texte.

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Modifiez le type de règle de format conditionnel sur personnalisé.

changeRuleToCustom(formula: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplacer le type de règle de mise en forme conditionnelle par barre de données.

changeRuleToDataBar(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplacez le type de règle de format conditionnel par jeu d’icônes.

changeRuleToIconSet(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Modifiez le type de règle de mise en forme conditionnelle en fonction de critères prédéfinis.

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplacez le type de règle de format conditionnel par haut/bas.

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Supprime cette mise en forme conditionnelle.

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie la plage à laquelle s’applique la mise en forme conditionnelle. Génère une erreur si la mise en forme conditionnelle est appliquée à plusieurs plages.

getRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.6

Exemples

// 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.");
    }
});

Renvoie la plage à laquelle la mise en forme conditionnelle est appliquée. Si la mise en forme conditionnelle est appliquée à plusieurs plages, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getRangeOrNullObject(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.6

Renvoie la RangeAreas, composée d’une ou plusieurs plages rectangulaires, à laquelle la mise en forme conditionnelle est appliquée.

getRanges(): Excel.RangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.ConditionalFormat): void;

Paramètres

Retours

Définir les plages auxquelles la règle de mise en forme conditionnelle est appliquée.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.17

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ConditionalFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ConditionalFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ConditionalFormatData;

Retours