Class ConditionalFormatRule

ConditionalFormatRule

Accédez aux règles de mise en forme conditionnelle. Pour créer une règle, utilisez SpreadsheetApp.newConditionalFormatRule() et ConditionalFormatRuleBuilder. Vous pouvez utiliser Sheet.setConditionalFormatRules(rules) pour définir les règles d'une feuille donnée.

Pour les règles qui utilisent des critères de condition booléenne, vous pouvez accéder aux paramètres de mise en forme en appelant getBooleanCondition() et en utilisant les méthodes sur l'objet BooleanCondition renvoyé.

Méthodes

Méthode	Type renvoyé	Brève description
copy()	ConditionalFormatRuleBuilder	Renvoie un préréglage de générateur de règles avec les paramètres de cette règle.
getBooleanCondition()	BooleanCondition|null	Récupère les informations BooleanCondition de la règle si elle utilise des critères de condition booléenne.
getGradientCondition()	GradientCondition|null	Récupère les informations GradientCondition de la règle si elle utilise des critères de condition de dégradé.
getRanges()	Range[]	Récupère les plages auxquelles cette règle de mise en forme conditionnelle est appliquée.

Documentation détaillée

copy()

Renvoie un préréglage de générateur de règles avec les paramètres de cette règle.

Renvois

ConditionalFormatRuleBuilder : générateur basé sur les paramètres de cette règle.

---

getBooleanCondition()

Récupère les informations BooleanCondition de la règle si elle utilise des critères de condition booléenne. Sinon, renvoie null. Les conditions booléennes contiennent des paramètres de mise en forme tels que l'épaisseur de la police, la couleur de la police et la couleur d'arrière-plan.

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

Renvois

BooleanCondition|null : 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 elle utilise des critères de condition de dégradé. Sinon, renvoie null.

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

Renvois

GradientCondition|null : objet de condition de dégradé ou null si la règle n'utilise pas de condition de dégradé.

---

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.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const ranges = rule.getRanges();
for (let 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.