Class BooleanCondition

BooleanCondition

אפשר לגשת לתנאים בוליאניים בכתובת ConditionalFormatRules. כל כלל של עיצוב מותנה יכול להכיל תנאי בוליאני אחד. התנאי הבוליאני עצמו מכיל קריטריון בוליאני (עם ערכים) והגדרות עיצוב. הקריטריון מוערך ביחס לתוכן של תא, והתוצאה היא הערך true או false. אם הקריטריון מקבל את הערך true, הגדרות העיצוב של התנאי מוחלות על התא.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getBackgroundObject()Color|nullמחזירה את צבע הרקע של התנאי הבוליאני הזה.
getBold()Boolean|nullהפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מדגיש את הטקסט, ואת הערך false אם התנאי הבוליאני הזה מסיר את ההדגשה מהטקסט.
getCriteriaType()BooleanCriteriaמחזירה את סוג הקריטריון של הכלל כפי שמוגדר ב-enum ‏BooleanCriteria.
getCriteriaValues()Object[]מקבלת מערך של ארגומנטים לקריטריונים של הכלל.
getFontColorObject()Color|nullמחזירה את צבע הגופן של התנאי הבוליאני הזה.
getItalic()Boolean|nullהפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מוסיף לטקסט הטיה, ומחזירה את הערך false אם התנאי הבוליאני הזה מסיר את ההטיה מהטקסט.
getStrikethrough()Boolean|nullהפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מוסיף קו חוצה לטקסט, ואת הערך false אם התנאי הבוליאני הזה מסיר את הקו החוצה מהטקסט.
getUnderline()Boolean|nullהפונקציה מחזירה true אם התנאי הבוליאני הזה מוסיף קו תחתון לטקסט, ומחזירה false אם התנאי הבוליאני הזה מסיר את הקו התחתון מהטקסט.

תיעוד מפורט

getBackgroundObject()

מחזירה את צבע הרקע של התנאי הבוליאני הזה. אם לא מוגדר ערך, הפונקציה מחזירה null. 

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

חזרה

‫Color|null – צבע הרקע, או null אם לא הוגדר צבע לתנאי הזה.

getBold()

הפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מדגיש את הטקסט, ואת הערך false אם התנאי הבוליאני הזה מסיר את ההדגשה מהטקסט. הפונקציה מחזירה null אם ההדגשה לא מושפעת. 

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

חזרה

‫Boolean|null – אם התנאי הבוליאני מדגיש את הטקסט או לא, או null אם ההדגשה לא מושפעת

getCriteriaType()

מחזירה את סוג הקריטריון של הכלל כפי שמוגדר ב-enum ‏BooleanCriteria. כדי לקבל את הארגומנטים של הקריטריונים, משתמשים בפונקציה getCriteriaValues(). כדי להשתמש בערכים האלה ליצירה או לשינוי של כלל לעיצוב מותנה, אפשר לעיין במאמר בנושא 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}`);
  }
});

חזרה

‫BooleanCriteria – סוג הקריטריונים לעיצוב מותנה.

getCriteriaValues()

מקבלת מערך של ארגומנטים לקריטריונים של הכלל. כדי לקבל את סוג הקריטריון, משתמשים בפונקציה getCriteriaType(). כדי להשתמש בערכים האלה כדי ליצור או לשנות כלל של עיצוב מותנה, אפשר לעיין במאמר בנושא 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}`);
  }
});

חזרה

‫Object[] — מערך של ארגומנטים שמתאימים לסוג הקריטריון של הכלל. מספר הארגומנטים והסוג שלהם תואמים לשיטת when...() המתאימה של המחלקה ConditionalFormatRuleBuilder.

getFontColorObject()

מחזירה את צבע הגופן של התנאי הבוליאני הזה. אם לא מוגדר ערך, הפונקציה מחזירה null. 

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

חזרה

‫Color|null – צבע הגופן, או null אם לא הוגדר עבור התנאי הזה.

getItalic()

הפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מוסיף לטקסט הטיה, ומחזירה את הערך false אם התנאי הבוליאני הזה מסיר את ההטיה מהטקסט. הפונקציה מחזירה את הערך null אם לא חל שינוי בטקסט המוטה. 

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

חזרה

‫Boolean|null — אם התנאי הבוליאני משפיע על הטיית הטקסט, או null אם ההטיה לא מושפעת

getStrikethrough()

הפונקציה מחזירה את הערך true אם התנאי הבוליאני הזה מוסיף קו חוצה לטקסט, ואת הערך false אם התנאי הבוליאני הזה מסיר את הקו החוצה מהטקסט. ‫Returns null if strikethrough is unaffected. 

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

חזרה

‫Boolean|null — אם התנאי הבוליאני חוצה את הטקסט או null אם הקו החוצה לא מושפע

getUnderline()

הפונקציה מחזירה true אם התנאי הבוליאני הזה מוסיף קו תחתון לטקסט, ומחזירה false אם התנאי הבוליאני הזה מסיר את הקו התחתון מהטקסט. הפונקציה מחזירה null אם ההדגשה בקו לא מושפעת. 

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

חזרה

‫Boolean|null — אם התנאי הבוליאני מוסיף קו תחתון לטקסט, או null אם הקו התחתון לא מושפע

שיטות שהוצאו משימוש