Class BooleanCondition

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

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

Методы

Метод Тип возвращаемого значения Краткое описание
get Background Object() Color |null Получает цвет фона для этого логического условия.
get Bold() Boolean|null Возвращает true , если это логическое условие выделяет текст жирным шрифтом, и false если это логическое условие снимает выделение жирным шрифтом.
get Criteria Type() Boolean Criteria Получает тип критериев правила, определенный в перечислении Boolean Criteria .
get Criteria Values() Object[] Получает массив аргументов для критериев правила.
get Font Color Object() Color |null Получает цвет шрифта для данного логического условия.
get Italic() Boolean|null Возвращает true , если это логическое условие выделяет текст курсивом, и false если это логическое условие удаляет курсив из текста.
get Strikethrough() Boolean|null Возвращает true если это логическое условие зачеркивает текст, и false если это логическое условие удаляет зачеркивание из текста.
get Underline() Boolean|null Возвращает true если это логическое условие подчеркивает текст, и false если это логическое условие удаляет подчеркивание из текста.

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

get Background Object()

Получает цвет фона для данного логического условия. Возвращает 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 , если для этого условия не задано.

get Bold()

Возвращает 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 если выделение жирным шрифтом не изменяется.

get Criteria Type()

Получает тип критериев правила, определенный в перечислении Boolean Criteria . Чтобы получить аргументы для критериев, используйте метод get Criteria Values() . Чтобы использовать эти значения для создания или изменения правила условного форматирования, см. Conditional Format Rule Builder.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}`);
  }
});

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

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

get Criteria Values()

Получает массив аргументов для критериев правила. Чтобы получить тип критериев, используйте get Criteria Type() . Чтобы использовать эти значения для создания или изменения правила условного форматирования, см. Conditional Format Rule Builder.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...() класса Conditional Format Rule Builder .

get Font Color Object()

Получает цвет шрифта для данного логического условия. Возвращает 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 , если для этого условия не задано.

get Italic()

Возвращает 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 если выделение курсивом не изменяется.

get Strikethrough()

Возвращает 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 — указывает, перечеркивает ли логическое условие текст, или null если перечеркивание не затрагивается.

get Underline()

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

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