Class ConditionalFormatRuleBuilder

ConditionalFormatRuleBuilder

Compilateur pour les règles de mise en forme conditionnelle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Méthodes

MéthodeType renvoyéBrève description
build()ConditionalFormatRuleConstruit une règle de mise en forme conditionnelle à partir des paramètres appliqués au compilateur.
copy()ConditionalFormatRuleBuilderAffiche un préréglage de l'outil de création de règle avec les paramètres de cette règle.
getBooleanCondition()BooleanConditionRécupère les informations BooleanCondition de la règle si celle-ci utilise des critères de condition booléens.
getGradientCondition()GradientConditionRécupère les informations GradientCondition de la règle si cette règle utilise des critères de condition de gradient.
getRanges()Range[]Récupère les plages auxquelles cette règle de mise en forme conditionnelle est appliquée.
setBackground(color)ConditionalFormatRuleBuilderDéfinit la couleur d'arrière-plan du format de la règle de mise en forme conditionnelle.
setBackgroundObject(color)ConditionalFormatRuleBuilderDéfinit la couleur d'arrière-plan du format de la règle de mise en forme conditionnelle.
setBold(bold)ConditionalFormatRuleBuilderDéfinit la mise en gras du texte pour le format de la règle de mise en forme conditionnelle.
setFontColor(color)ConditionalFormatRuleBuilderDéfinit la couleur de la police pour le format de la règle de mise en forme conditionnelle.
setFontColorObject(color)ConditionalFormatRuleBuilderDéfinit la couleur de la police pour le format de la règle de mise en forme conditionnelle.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderEfface la valeur du point maximal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur maximale des plages de la règle.
setGradientMaxpointObject(color)ConditionalFormatRuleBuilderEfface la valeur du point maximal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur maximale des plages de la règle.
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point maximal du dégradé de la règle de mise en forme conditionnelle.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point maximal du dégradé de la règle de mise en forme conditionnelle.
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point médian du dégradé de la règle de mise en forme conditionnelle.
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point médian du dégradé de la règle de mise en forme conditionnelle.
setGradientMinpoint(color)ConditionalFormatRuleBuilderEfface la valeur du point minimal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur minimale des plages de la règle.
setGradientMinpointObject(color)ConditionalFormatRuleBuilderEfface la valeur du point minimal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur minimale des plages de la règle.
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point minimal du dégradé de la règle de mise en forme conditionnelle.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderDéfinit les champs de point minimal du dégradé de la règle de mise en forme conditionnelle.
setItalic(italic)ConditionalFormatRuleBuilderMet le texte en italique pour le format de la règle de mise en forme conditionnelle.
setRanges(ranges)ConditionalFormatRuleBuilderDéfinit une ou plusieurs plages auxquelles cette règle de mise en forme conditionnelle est appliquée.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderDéfinit le texte barré pour le format de la règle de mise en forme conditionnelle.
setUnderline(underline)ConditionalFormatRuleBuilderDéfinit le texte souligné pour le format de la règle de mise en forme conditionnelle.
whenCellEmpty()ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque la cellule est vide.
whenCellNotEmpty()ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque la cellule n'est pas vide.
whenDateAfter(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est postérieure à la valeur donnée.
whenDateAfter(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est postérieure à la date relative donnée.
whenDateBefore(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est antérieure à la date donnée.
whenDateBefore(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est antérieure à la date relative donnée.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est égale à la date donnée.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est égale à la date relative donnée.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque la formule donnée renvoie la valeur true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre se trouve entre deux valeurs spécifiées ou correspond à l'une des deux.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est égal à la valeur donnée.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est supérieur à la valeur donnée.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est supérieur ou égal à la valeur donnée.
whenNumberLessThan(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle conditionnelle à déclencher lorsqu'un nombre est inférieur à la valeur donnée.
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est inférieur ou égal à la valeur donnée.
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre ne se trouve pas entre deux valeurs spécifiées et n'en est aucune.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre n'est pas égal à la valeur donnée.
whenTextContains(text)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée contient la valeur donnée.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée ne contient pas la valeur donnée.
whenTextEndsWith(text)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée se termine par la valeur donnée.
whenTextEqualTo(text)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée est égale à la valeur donnée.
whenTextStartsWith(text)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée commence par la valeur donnée.
withCriteria(criteria, args)ConditionalFormatRuleBuilderDéfinit la règle de mise en forme conditionnelle sur des critères définis par des valeurs BooleanCriteria, généralement extraites de l'élément criteria et arguments d'une règle existante.

Documentation détaillée

build()

Construit une règle de mise en forme conditionnelle à partir des paramètres appliqués au compilateur.

Renvois

ConditionalFormatRule : représentation de la règle de mise en forme conditionnelle


copy()

Affiche un préréglage de l'outil de création de règle avec les paramètres de cette règle.

Renvois

ConditionalFormatRuleBuilder : outil de création basé sur les paramètres de cette règle


getBooleanCondition()

Récupère les informations BooleanCondition de la règle si celle-ci utilise des critères de condition booléens. Sinon, renvoie null.

// Log the boolean criteria type of the first conditional format rules of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var booleanCondition = rule.getBooleanCondition();
if (booleanCondition != null) {
  Logger.log(booleanCondition.getCriteriaType());
}

Renvois

BooleanCondition : objet de condition booléenne, ou null si la règle n'utilise pas de condition booléenne.


getGradientCondition()

Récupère les informations GradientCondition de la règle si cette règle utilise des critères de condition de gradient. Sinon, renvoie null.

// Log the gradient minimum color of the first conditional format rule of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var gradientCondition = rule.getGradientCondition();
if (gradientCondition != null) {
  // Assume the color has ColorType.RGB.
  Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString());
}

Renvois

GradientCondition : objet de condition de gradient, ou null si la règle n'utilise pas de condition de gradient.


getRanges()

Récupère les plages auxquelles cette règle de mise en forme conditionnelle est appliquée.

// Log each range of the first conditional format rule of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var ranges = rule.getRanges();
for (var i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

Renvois

Range[] : plages auxquelles cette règle de mise en forme conditionnelle est appliquée.


setBackground(color)

Définit la couleur d'arrière-plan du format de la règle de mise en forme conditionnelle. La transmission de null supprime de la règle le paramètre de format de la couleur d'arrière-plan.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color to red if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur ou null à effacer.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setBackgroundObject(color)

Définit la couleur d'arrière-plan du format de la règle de mise en forme conditionnelle. La transmission de null supprime de la règle le paramètre de format de la couleur d'arrière-plan.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color to theme background color if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground(color)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorObjet couleur ou null à effacer.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setBold(bold)

Définit la mise en gras du texte pour le format de la règle de mise en forme conditionnelle. Si bold correspond à true, la règle met le texte en gras si la condition est remplie. Si false, la règle supprime toute mise en gras existante si la condition est remplie. Si vous transmettez null, le paramètre de mise en gras est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn their
// text bold if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBold(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
boldBooleanIndique si le texte doit être en gras si la condition de mise en forme est remplie. null supprime ce paramètre.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setFontColor(color)

Définit la couleur de la police pour le format de la règle de mise en forme conditionnelle. Si vous transmettez null, le paramètre de format de couleur de police est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their font
// color to red if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setFontColor("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur ou null à effacer.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setFontColorObject(color)

Définit la couleur de la police pour le format de la règle de mise en forme conditionnelle. Si vous transmettez null, le paramètre de format de couleur de police est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their font
// color to theme text color if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setFontColor(color)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorObjet couleur ou null à effacer.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMaxpoint(color)

Efface la valeur du point maximal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur maximale des plages de la règle. Définit également la couleur du point maximal du dégradé sur la couleur d'entrée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between white and red, based on their values in comparison to
// the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint("#FF0000")
    .setGradientMinpoint("#FFFFFF")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur du point maximal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setGradientMaxpointObject(color)

Efface la valeur du point maximal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur maximale des plages de la règle. Définit également la couleur du point maximal du dégradé sur la couleur d'entrée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between theme text and background colors, based on their values
// in comparison to the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var textColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var backgroundColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint(textColor)
    .setGradientMinpoint(backgroundColor)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorObjet couleur du point maximal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMaxpointObjectWithValue(color, type, value)

Définit les champs de point maximal du dégradé de la règle de mise en forme conditionnelle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1, accent 2 to accent 3 colors, based on their
// values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorCouleur du point maximal à définir.
typeInterpolationTypeType d'interpolation du point maximal à définir.
valueStringValeur du point maximal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMaxpointWithValue(color, type, value)

Définit les champs de point maximal du dégradé de la règle de mise en forme conditionnelle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur du point maximal à définir.
typeInterpolationTypeType d'interpolation du point maximal à définir.
valueStringValeur du point maximal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setGradientMidpointObjectWithValue(color, type, value)

Définit les champs de point médian du dégradé de la règle de mise en forme conditionnelle. Efface tous les champs de point médian si le type d'interpolation transmis est null.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1 to accent 2 to accent 3 colors, based on
// their values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorCouleur du point médian à définir.
typeInterpolationTypeType d'interpolation du point médian à définir ou null à effacer.
valueStringValeur du point médian à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMidpointWithValue(color, type, value)

Définit les champs de point médian du dégradé de la règle de mise en forme conditionnelle. Efface tous les champs de point médian si le type d'interpolation transmis est null.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur du point médian à définir.
typeInterpolationTypeType d'interpolation du point médian à définir ou null à effacer.
valueStringValeur du point médian à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setGradientMinpoint(color)

Efface la valeur du point minimal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur minimale des plages de la règle. Définit également la couleur du point minimal du dégradé sur la couleur d'entrée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between white and red, based on their values in comparison to
// the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint("#FF0000")
    .setGradientMinpoint("#FFFFFF")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur du point minimal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setGradientMinpointObject(color)

Efface la valeur du point minimal du dégradé de la règle de mise en forme conditionnelle et utilise à la place la valeur minimale des plages de la règle. Définit également la couleur du point minimal du dégradé sur la couleur d'entrée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between theme text and background colors, based on their values
// in comparison to the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var textColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var backgroundColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint(textColor)
    .setGradientMinpoint(backgroundColor)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorObjet couleur du point minimal à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMinpointObjectWithValue(color, type, value)

Définit les champs de point minimal du dégradé de la règle de mise en forme conditionnelle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1 to accent 2 to accent 3 colors, based on
// their values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorColorCouleur du point minimal à définir.
typeInterpolationTypeType d'interpolation du point minimal à définir.
valueStringValeur minimale à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage.


setGradientMinpointWithValue(color, type, value)

Définit les champs de point minimal du dégradé de la règle de mise en forme conditionnelle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red to green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
colorStringCouleur du point minimal à définir.
typeInterpolationTypeType d'interpolation du point minimal à définir.
valueStringValeur minimale à définir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setItalic(italic)

Met le texte en italique pour le format de la règle de mise en forme conditionnelle. Si italic est défini sur true, la règle met le texte en italique si la condition est remplie. Si false, la règle supprime toute italique existante si la condition est remplie. Si vous transmettez null, le paramètre de mise en italique est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn their
// text italic if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setItalic(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
italicBooleanIndique si le texte doit être mis en italique si la condition de mise en forme est remplie. null supprime ce paramètre.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setRanges(ranges)

Définit une ou plusieurs plages auxquelles cette règle de mise en forme conditionnelle est appliquée. Cette opération remplace toutes les plages existantes. Définir un tableau vide efface toutes les plages existantes. Une règle doit comporter au moins une plage.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 and range D4:F6
// to turn red if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeOne = sheet.getRange("A1:B3");
var rangeTwo = sheet.getRange("D4:F6");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([rangeOne, rangeTwo])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
rangesRange[]Plages auxquelles cette règle de mise en forme conditionnelle est appliquée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setStrikethrough(strikethrough)

Définit le texte barré pour le format de la règle de mise en forme conditionnelle. Si strikethrough est défini sur true, la règle barre le texte si la condition est remplie. Si la valeur est false, la règle supprime toute mise en forme barrée existante si la condition est remplie. Si vous transmettez null, le paramètre de format barré est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to strikethrough
// their text if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setStrikethrough(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
strikethroughBooleanIndique si le texte doit être barré si la condition de mise en forme est remplie. null supprime ce paramètre.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


setUnderline(underline)

Définit le texte souligné pour le format de la règle de mise en forme conditionnelle. Si underline correspond à true, la règle souligne le texte si la condition est remplie. Si la valeur est false, tous les traits de soulignement existants sont supprimés si la condition est remplie. Si vous transmettez null, le paramètre de format de soulignement est supprimé de la règle.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to underline
// their text if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setUnderline(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
underlineBooleanIndique si le texte doit être souligné si la condition de mise en forme est remplie. null supprime ce paramètre.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenCellEmpty()

Définit la règle de mise en forme conditionnelle à déclencher lorsque la cellule est vide.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they are empty.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenCellEmpty()
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenCellNotEmpty()

Définit la règle de mise en forme conditionnelle à déclencher lorsque la cellule n'est pas vide.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they are not empty.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenCellNotEmpty()
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateAfter(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est postérieure à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date after 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateAfter(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateDateLa dernière date.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateAfter(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est postérieure à la date relative donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date after today.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateRelativeDateDate la plus récente par rapport au type de date sélectionné.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateBefore(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est antérieure à la date donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date before 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateBefore(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateDatePremière date non autorisée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateBefore(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est antérieure à la date relative donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date before today.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateRelativeDateDate la plus récente par rapport au type de date sélectionné.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateEqualTo(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est égale à la date donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the date 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateEqualTo(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateDateSeule date acceptable.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenDateEqualTo(date)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'une date est égale à la date relative donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain todays date.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateEqualTo(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
dateRelativeDateDate la plus récente par rapport au type de date sélectionné.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenFormulaSatisfied(formula)

Définit la règle de mise en forme conditionnelle à déclencher lorsque la formule donnée renvoie la valeur true.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they satisfy the condition "=EQ(B4, C3)".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenFormulaSatisfied("=EQ(B4, C3)")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
formulaStringFormule personnalisée qui renvoie la valeur true si l'entrée est valide.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberBetween(start, end)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre se trouve entre deux valeurs spécifiées ou correspond à l'une des deux.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number between 1 and 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
startNumberValeur acceptable la plus basse.
endNumberValeur acceptable la plus élevée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberEqualTo(number)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est égal à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the number 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberSeule valeur acceptable.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberGreaterThan(number)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est supérieur à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red
// if they contain a number greater than 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberGreaterThan(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberValeur inacceptable la plus élevée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberGreaterThanOrEqualTo(number)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est supérieur ou égal à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number greater than or equal to 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberGreaterThanOrEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberValeur acceptable la plus basse.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberLessThan(number)

Définit la règle de mise en forme conditionnelle conditionnelle à déclencher lorsqu'un nombre est inférieur à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number less than 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberLessThan(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberValeur la plus basse inacceptable.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberLessThanOrEqualTo(number)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre est inférieur ou égal à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number less than or equal to 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberLessThanOrEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberValeur acceptable la plus élevée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberNotBetween(start, end)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre ne se trouve pas entre deux valeurs spécifiées et n'en est aucune.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number not between 1 and 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberNotBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
startNumberValeur la plus basse inacceptable.
endNumberValeur inacceptable la plus élevée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenNumberNotEqualTo(number)

Définit la règle de mise en forme conditionnelle à déclencher lorsqu'un nombre n'est pas égal à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they don't contain the number 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberNotEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
numberNumberSeule valeur non autorisée.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenTextContains(text)

Définit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée contient la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextContains("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
textStringValeur que l'entrée doit contenir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenTextDoesNotContain(text)

Définit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée ne contient pas la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they don't contain the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextDoesNotContain("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
textStringValeur que l'entrée ne doit pas contenir.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenTextEndsWith(text)

Définit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée se termine par la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they end with the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEndsWith("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
textStringTexte à comparer à la fin de la chaîne.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenTextEqualTo(text)

Définit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée est égale à la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they have text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
textStringSeule valeur acceptable.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


whenTextStartsWith(text)

Définit la règle de mise en forme conditionnelle à déclencher lorsque l'entrée commence par la valeur donnée.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they start with the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextStartsWith("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
textStringTexte à comparer au début de la chaîne.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage


withCriteria(criteria, args)

Définit la règle de mise en forme conditionnelle sur des critères définis par des valeurs BooleanCriteria, généralement extraites de l'élément criteria et arguments d'une règle existante.

// Adds a new conditional format rule that is a copy of the first active
// conditional format rule, except it instead sets its cells to have a black
// background color.

var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
var booleanCondition = rules[0].getBooleanCondition();
if (booleanCondition != null) {
  var rule = SpreadsheetApp.newConditionalFormatRule()
      .withCriteria(booleanCondition.getCriteriaType(),
         booleanCondition.getCriteriaValues())
      .setBackground("#000000")
      .setRanges(rule.getRanges())
      .build();
  rules.push(rule);
}
sheet.setConditionalFormatRules(rules);

Paramètres

NomTypeDescription
criteriaBooleanCriteriaType de critère de mise en forme conditionnelle.
argsObject[]Tableau d'arguments adapté au type de critère. Le nombre d'arguments et leur type correspondent à la méthode when...() correspondante ci-dessus.

Renvois

ConditionalFormatRuleBuilder : compilateur, pour le chaînage