Class ConditionalFormatRule

قاعدةالتنسيقالشرطي

الوصول إلى قواعد التنسيق الشرطي لإنشاء قاعدة جديدة، استخدِم SpreadsheetApp.newConditionalFormatRule() وConditionalFormatRuleBuilder. يمكنك استخدام Sheet.setConditionalFormatRules(rules) لضبط قواعد ورقة بيانات معيّنة.

بالنسبة إلى القواعد التي تستخدم معايير شرط منطقي، يمكنك الوصول إلى إعدادات التنسيق من خلال استدعاء getBooleanCondition() واستخدام الطرق في العنصر BooleanCondition الذي تم عرضه.

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
copy()ConditionalFormatRuleBuilderتعرض هذه الطريقة إعدادًا مُسبقًا لأداة إنشاء القواعد يتضمّن إعدادات هذه القاعدة.
getBooleanCondition()BooleanCondition|nullتعرض هذه السمة معلومات BooleanCondition الخاصة بالقاعدة إذا كانت هذه القاعدة تستخدم معايير شرطية منطقية.
getGradientCondition()GradientCondition|nullتعرض هذه السمة معلومات GradientCondition الخاصة بالقاعدة، إذا كانت هذه القاعدة تستخدم معايير شرط التدرّج.
getRanges()Range[]تعرض هذه الدالة النطاقات التي يتم تطبيق قاعدة التنسيق الشرطي عليها.

مستندات تفصيلية

copy()

تعرض هذه الطريقة إعدادًا مُسبقًا لأداة إنشاء القواعد يتضمّن إعدادات هذه القاعدة.

الإرجاع

‫ConditionalFormatRuleBuilder: أداة إنشاء تستند إلى إعدادات هذه القاعدة.

getBooleanCondition()

تعرض هذه السمة معلومات BooleanCondition الخاصة بالقاعدة إذا كانت هذه القاعدة تستخدم معايير شرطية منطقية. بخلاف ذلك، تعرض null. تحتوي الشروط المنطقية على إعدادات التنسيق، مثل سُمك الخط ولون الخط ولون الخلفية. 

// Log the boolean criteria type of the first conditional format rules of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const booleanCondition = rule.getBooleanCondition();
if (booleanCondition != null) {
  Logger.log(booleanCondition.getCriteriaType());
}

الإرجاع

‫BooleanCondition|null: عنصر الشرط المنطقي، أو null إذا كانت القاعدة لا تستخدم شرطًا منطقيًا.

getGradientCondition()

تعرض هذه السمة معلومات GradientCondition الخاصة بالقاعدة، إذا كانت هذه القاعدة تستخدم معايير شرط التدرّج. بخلاف ذلك، تعرض null. 

// Log the gradient minimum color of the first conditional format rule of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const gradientCondition = rule.getGradientCondition();
if (gradientCondition != null) {
  // Assume the color has ColorType.RGB.
  Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString());
}

الإرجاع

‫GradientCondition|null: عنصر شرط التدرّج أو null إذا كانت القاعدة لا تستخدم شرط التدرّج

getRanges()

تعرض هذه الدالة النطاقات التي يتم تطبيق قاعدة التنسيق الشرطي عليها. 

// Log each range of the first conditional format rule of a sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const ranges = rule.getRanges();
for (let i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

الإرجاع

Range[]: النطاقات التي يتم تطبيق قاعدة التنسيق الشرطي هذه عليها