Class ConditionalFormatRule

قانون قالب شرطی

دسترسی به قوانین قالب‌بندی شرطی. برای ایجاد یک قانون جدید، از SpreadsheetApp.newConditionalFormatRule() و ConditionalFormatRuleBuilder استفاده کنید. می‌توانید Sheet.setConditionalFormatRules(rules) برای تنظیم قوانین برای یک برگه مشخص استفاده کنید.

برای قوانینی که از معیارهای شرط بولی استفاده می‌کنند، می‌توانید با فراخوانی getBooleanCondition() و استفاده از متدهای شیء BooleanCondition برگردانده شده، به تنظیمات قالب‌بندی دسترسی پیدا کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Conditional Format Rule Builder یک پیش‌تنظیم سازنده‌ی قانون با تنظیمات این قانون برمی‌گرداند.
get Boolean Condition() Boolean Condition |null اگر این قانون از معیارهای شرط بولی استفاده کند، اطلاعات Boolean Condition آن قانون را بازیابی می‌کند.
get Gradient Condition() Gradient Condition |null اطلاعات Gradient Condition قانون را بازیابی می‌کند، اگر این قانون از معیارهای شرط گرادیان استفاده کند.
get Ranges() 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[] — محدوده‌هایی که این قانون قالب‌بندی شرطی روی آنها اعمال می‌شود.