Class BooleanCondition

Логическое условие

Доступ к логическим условиям в ConditionalFormatRules . Каждое правило условного формата может содержать одно логическое условие. Само логическое условие содержит логические критерии (со значениями) и настройки форматирования. Критерий оценивается по содержимому ячейки, что приводит к true или false значению. Если критерий имеет значение true , к ячейке применяются параметры форматирования условия.

Методы

Метод Тип возврата Краткое описание
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 если это логическое условие удаляет подчеркивание из текста.
Метод Тип возврата Краткое описание
getBackground() String Получает строку цвета фона для этого логического условия.
getFontColor() String Получает строку цвета шрифта для этого логического условия.

Подробная документация

getBackgroundObject()

Получает цвет фона для этого логического условия. Возвращает null , если не установлено.

// Logs the boolean condition background color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getBackgroundObject();
  Logger.log("The background color for rule %s is %s", i, color.asRgbColor().asHexString());
}

Возвращаться

Color — цвет фона или null , если оно не установлено для этого условия.


getBold()

Возвращает true , если это логическое условие выделяет текст полужирным шрифтом, и возвращает false если это логическое условие удаляет жирный шрифт из текста. Возвращает null , если выделение жирным шрифтом не изменено.

// Logs the boolean condition font weight for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var bold = rules[i].getBooleanCondition().getBold();
  Logger.log("The font bold setting for rule %s is %b", i, weight);
}

Возвращаться

Boolean — указывает, выделяет ли текст жирным шрифтом логическое условие, или null если выделение жирным шрифтом не затрагивается.


getCriteriaType()

Получает тип критерия правила, определенный в перечислении BooleanCriteria . Чтобы получить аргументы для критериев, используйте getCriteriaValues() . Чтобы использовать эти значения для создания или изменения правила условного форматирования, см. раздел ConditionalFormatRuleBuilder.withCriteria(criteria, args) .

// Log information about the conditional formats on the active sheet that use
// boolean conditions.
var sheet = SpreadsheetApp.getActiveSheet;
var formats = sheet.getConditionalFormats();
sheet.getConditionalFormats().forEach(function(format) {
  var booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    var criteria = booleanCondition.getCriteriaType();
    var args = booleanCondition.getCriteriaValues();
    Logger.log('The conditional format rule is %s %s', criteria, args);
  }
});

Возвращаться

BooleanCriteria — тип критериев условного форматирования.


getCriteriaValues()

Получает массив аргументов для критериев правила. Чтобы получить тип критерия, используйте getCriteriaType() . Чтобы использовать эти значения для создания или изменения правила условного форматирования, см. раздел ConditionalFormatRuleBuilder.withCriteria(criteria, args) .

// Log information about the conditional formats on the active sheet that use
// boolean conditions.
var sheet = SpreadsheetApp.getActiveSheet;
var formats = sheet.getConditionalFormats();
sheet.getConditionalFormats().forEach(function(format) {
  var booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    var criteria = booleanCondition.getCriteriaType();
    var args = booleanCondition.getCriteriaValues();
    Logger.log('The conditional format rule is %s %s', criteria, args);
  }
});

Возвращаться

Object[] — массив аргументов, соответствующий типу критериев правила; количество аргументов и их тип соответствуют соответствующему методу when...() класса ConditionalFormatRuleBuilder


getFontColorObject()

Получает цвет шрифта для этого логического условия. Возвращает null , если не установлено.

// Logs the boolean condition font color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getFontColorObject();
  Logger.log("The font color for rule %s is %s", i, color.asRgbColor().asHexString());
}

Возвращаться

Color — цвет шрифта или null , если оно не установлено для этого условия.


getItalic()

Возвращает true , если это логическое условие выделяет текст курсивом, и возвращает false если это логическое условие удаляет курсив из текста. Возвращает null , если курсив не изменен.

// Logs the boolean condition font style for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var italic = rules[i].getBooleanCondition().getItalic();
  Logger.log("The font italic setting for rule %s is %b", i, italic);
}

Возвращаться

Boolean — независимо от того, выделяет ли текст курсивом логическое условие, или null , если курсив не затрагивается.


getStrikethrough()

Возвращает true , если это логическое условие зачеркивает текст, и возвращает false если это логическое условие удаляет зачеркивание из текста. Возвращает null , если зачеркивание не затронуто.

// Logs the boolean condition strikethrough setting for each conditional format rule on a
// sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var strikethrough = rules[i].getBooleanCondition().getStrikethrough();
  Logger.log("The font strikethrough setting for rule %s is %b", i, strikethrough);
}

Возвращаться

Boolean — зачеркивает ли текст логическое условие или null , если зачеркивание не затрагивается.


getUnderline()

Возвращает true , если это логическое условие подчеркивает текст, и возвращает false если это логическое условие удаляет подчеркивание из текста. Возвращает null , если подчеркивание не изменено.

// Logs the boolean condition underline setting for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var underline = rules[i].getBooleanCondition().getUnderline();
  Logger.log("The font underline setting for rule %s is %b", i, underline);
}

Возвращаться

Boolean — подчеркивает ли логическое условие текст или null , если подчеркивание не затрагивается.

Устаревшие методы

Устарело. Заменено getBackgroundObject()

Получает строку цвета фона для этого логического условия. Возвращает null , если не установлено.

// Logs the boolean condition background color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getBackground();
  Logger.log("The background color for rule %s is %s", i, color);
}

Возвращаться

String — строка цвета фона или null , если для этого условия не установлено.


Устарело. Заменено на getFontColorObject()

Получает строку цвета шрифта для этого логического условия. Возвращает null , если не установлено.

// Logs the boolean condition font color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getFontColor();
  Logger.log("The font color for rule %s is %s", i, color);
}

Возвращаться

String — строка цвета шрифта или null , если не установлено для этого условия.