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 если это логическое условие удаляет подчеркивание из текста.

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

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 , если подчеркивание не затрагивается.

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