Class BooleanCondition

BooleanCondition

Accédez aux conditions booléennes dans ConditionalFormatRules. Chaque règle de mise en forme conditionnelle peut contenir une seule condition booléenne. La condition booléenne elle-même contient un critère booléen (avec des valeurs) et des paramètres de mise en forme. Les critères sont évalués par rapport au contenu d'une cellule, ce qui donne une valeur true ou false. Si les critères renvoient true, les paramètres de mise en forme de la condition sont appliqués à la cellule.

Méthodes

MéthodeType renvoyéBrève description
getBackgroundObject()Color|nullRécupère la couleur d'arrière-plan de cette condition booléenne.
getBold()Boolean|nullRenvoie true si cette condition booléenne met le texte en gras et false si elle le supprime.
getCriteriaType()BooleanCriteriaRécupère le type de critère de la règle tel qu'il est défini dans l'énumération BooleanCriteria.
getCriteriaValues()Object[]Obtient un tableau d'arguments pour les critères de la règle.
getFontColorObject()Color|nullRécupère la couleur de police pour cette condition booléenne.
getItalic()Boolean|nullRenvoie true si cette condition booléenne met le texte en italique et false si elle supprime l'italique du texte.
getStrikethrough()Boolean|nullRenvoie true si cette condition booléenne barre le texte et false si elle supprime la barre.
getUnderline()Boolean|nullRenvoie true si cette condition booléenne souligne le texte et false si elle supprime le soulignement du texte.

Documentation détaillée

getBackgroundObject()

Récupère la couleur d'arrière-plan de cette condition booléenne. Renvoie null si elle n'est pas définie. 

// Logs the boolean condition background color for each conditional format rule
// on a sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const color = rule.getBooleanCondition().getBackgroundObject();
  Logger.log(`Background color: ${color.asRgbColor().asHexString()}`);
}

Renvois

Color|null : couleur d'arrière-plan ou null si elle n'est pas définie pour cette condition.

getBold()

Renvoie true si cette condition booléenne met le texte en gras et false si elle le supprime. Renvoie null si la mise en gras n'est pas affectée. 

// Logs the boolean condition font weight for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const bold = rule.getBooleanCondition().getBold();
  Logger.log(`Bold: ${bold}`);
}

Renvois

Boolean|null : indique si la condition booléenne met le texte en gras ou null si la mise en gras n'est pas affectée.

getCriteriaType()

Récupère le type de critère de la règle tel qu'il est défini dans l'énumération BooleanCriteria. Pour obtenir les arguments des critères, utilisez getCriteriaValues(). Pour utiliser ces valeurs afin de créer ou de modifier une règle de mise en forme conditionnelle, consultez ConditionalFormatRuleBuilder.withCriteria(criteria, args). 

// Log information about the conditional formats on the active sheet that use
// boolean conditions.

const formats = SpreadsheetApp.getActiveSheet.getConditionalFormats();
SpreadsheetApp.getActiveSheet.getConditionalFormats().forEach((format) => {
  const booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    const criteria = booleanCondition.getCriteriaType();
    const args = booleanCondition.getCriteriaValues();
    Logger.log(`The conditional format rule is ${criteria} ${args}`);
  }
});

Renvois

BooleanCriteria : type de critère de mise en forme conditionnelle.

getCriteriaValues()

Obtient un tableau d'arguments pour les critères de la règle. Pour obtenir le type de critère, utilisez getCriteriaType(). Pour utiliser ces valeurs afin de créer ou de modifier une règle de mise en forme conditionnelle, consultez ConditionalFormatRuleBuilder.withCriteria(criteria, args). 

// Log information about the conditional formats on the active sheet that use
// boolean conditions.

const formats = SpreadsheetApp.getActiveSheet.getConditionalFormats();
SpreadsheetApp.getActiveSheet.getConditionalFormats().forEach((format) => {
  const booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    const criteria = booleanCondition.getCriteriaType();
    const args = booleanCondition.getCriteriaValues();
    Logger.log(`The conditional format rule is ${criteria} ${args}`);
  }
});

Renvois

Object[] : tableau d'arguments adaptés au type de critère de la règle. Le nombre d'arguments et leur type correspondent à la méthode when...() correspondante de la classe ConditionalFormatRuleBuilder.

getFontColorObject()

Récupère la couleur de police pour cette condition booléenne. Renvoie null si elle n'est pas définie. 

// Logs the boolean condition font color for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const color = rule.getBooleanCondition().getFontColorObject();
  Logger.log(`Font color: ${color.asRgbColor().asHexString()}`);
}

Renvois

Color|null : couleur de la police ou null si elle n'est pas définie pour cette condition.

getItalic()

Renvoie true si cette condition booléenne met le texte en italique et false si elle supprime l'italique du texte. Renvoie null si l'italique n'est pas affecté. 

// Logs the boolean condition font style for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const italic = rule.getBooleanCondition().getItalic();
  Logger.log(`Italic: ${italic}`);
}

Renvois

Boolean|null : indique si la condition booléenne met le texte en italique ou null si la mise en italique n'est pas affectée.

getStrikethrough()

Renvoie true si cette condition booléenne barre le texte et false si elle supprime la barre. Renvoie null si la mise en forme barrée n'est pas affectée. 

// Logs the boolean condition strikethrough setting for each conditional format
// rule on a sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const strikethrough = rule.getBooleanCondition().getStrikethrough();
  Logger.log(`Strikethrough: ${strikethrough}`);
}

Renvois

Boolean|null : indique si la condition booléenne barre le texte ou null si la barre n'est pas affectée.

getUnderline()

Renvoie true si cette condition booléenne souligne le texte et false si elle supprime le soulignement du texte. Renvoie null si la mise en forme soulignée n'est pas affectée. 

// Logs the boolean condition underline setting for each conditional format rule
// on a sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const underline = rule.getBooleanCondition().getUnderline();
  Logger.log(`Underline: ${underline}`);
}

Renvois

Boolean|null : indique si la condition booléenne souligne le texte ou null si le soulignement n'est pas affecté.

Méthodes obsolètes