Class BooleanCondition

BooleanCondition

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

Methods

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

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 אם ההדגשה לא מושפעת

getCriteriaType()

הפונקציה מקבלת את סוג הקריטריונים של הכלל כפי שהוא מוגדר במערך הערכים הקבועים 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 אם לא הוגדר תנאי כזה.

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 אם הטיה לא תתרחש

getStrikethrough()

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

// 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 אם הוספת הקו החוצה לא מושפעת

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 אם ההוספה של קו תחתון לא מושפעת

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