Class BooleanCondition

BooleanCondition

Accédez aux conditions booléennes dans ConditionalFormatRules. Chaque règle de format conditionnel ne peut contenir qu'une seule condition booléenne. La condition booléenne elle-même contient des critères booléens (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()ColorRécupère la couleur d'arrière-plan de cette condition booléenne.
getBold()BooleanRenvoie true si cette condition booléenne met en gras le texte et renvoie false si cette condition booléenne supprime le texte en gras.
getCriteriaType()BooleanCriteriaRécupère le type de critères de la règle tel que défini dans l'énumération BooleanCriteria.
getCriteriaValues()Object[]Récupère un tableau d'arguments pour les critères de la règle.
getFontColorObject()ColorRécupère la couleur de police de cette condition booléenne.
getItalic()BooleanRenvoie true si cette condition booléenne met le texte en italique et false si elle le supprime.
getStrikethrough()BooleanRenvoie true si cette condition booléenne barre le texte et false si elle le supprime.
getUnderline()BooleanRenvoie 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 la valeur 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 : couleur de l'arrière-plan, ou null si elle n'est pas définie pour cette condition.

getBold()

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

// 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 : indique si la condition booléenne met en gras le texte ou non, ou null si le gras n'est pas affecté.

getCriteriaType()

Récupère le type de critères de la règle tel que 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ères de mise en forme conditionnelle.

getCriteriaValues()

Récupère un tableau d'arguments pour les critères de la règle. Pour obtenir le type de critères, utilisez getCriteriaType(). Pour utiliser ces valeurs pour créer ou 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 approprié au type de critères 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 la police pour cette condition booléenne. Renvoie null si la valeur 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 : 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 le supprime. Renvoie null si les italiques ne sont pas affectés. 

// 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 : indique si la condition booléenne met le texte en italique ou non, ou null si l'italique n'est pas affectée.

getStrikethrough()

Renvoie true si cette condition booléenne barre le texte et false si elle le supprime. Renvoie null si le trait est inchangé. 

// 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 : indique si la condition booléenne barre le texte ou non, ou null si le texte n'est pas barré.

getUnderline()

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

// 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 : indique si la condition booléenne souligne le texte ou non, ou null si le soulignement n'est pas affecté.

Méthodes obsolètes