Class DataValidation

DataValidation

データの入力規則にアクセスする。新しいルールを作成するには、SpreadsheetApp.newDataValidation() と DataValidationBuilder を使用します。次を使用: Range.setDataValidation(rule): 範囲の検証ルールを設定します。 

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

メソッド

メソッド戻り値の型概要
copy()DataValidationBuilderこのルールの設定に基づいて、データ入力規則のビルダーを作成します。
getAllowInvalid()Boolean入力がデータの検証で不合格だった場合にルールが警告を表示する場合は true を返し、入力が完全に拒否された場合は false を返します。
getCriteriaType()DataValidationCriteriaDataValidationCriteria 列挙型で定義されているルールの条件タイプを取得します。
getCriteriaValues()Object[]ルールの条件を表す引数の配列を取得します。
getHelpText()Stringルールのヘルプテキストを取得します。ヘルプテキストが設定されていない場合は null を取得します。

詳細なドキュメント

copy()

このルールの設定に基づいて、データ入力規則のビルダーを作成します。 

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

戻る

DataValidationBuilder - このルールの設定に基づくビルダー

getAllowInvalid()

入力がデータの検証で不合格だった場合にルールが警告を表示する場合は true を返し、入力が完全に拒否された場合は false を返します。新しいデータ入力規則のデフォルトは true です。

戻る

Boolean - データの検証で不合格だった入力がルールで許可されている場合は true。含まれていない場合は false

getCriteriaType()

DataValidationCriteria 列挙型で定義されているルールの条件タイプを取得します。取得するには、 getCriteriaValues() を使用します。これらの値を使用して データの入力規則を変更する場合は、DataValidationBuilder.withCriteria(criteria, args) をご覧ください。 

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

戻る

DataValidationCriteria - データ検証基準のタイプ

getCriteriaValues()

ルールの条件を表す引数の配列を取得します。条件タイプを取得するには、getCriteriaType() を使用します。これらの値を使用してデータの入力規則を作成または変更するには、DataValidationBuilder.withCriteria(criteria, args) をご覧ください。 

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

戻る

Object[] - ルールの条件タイプに応じた引数の配列。引数の数 かつ、その型が DataValidationBuilder クラスの対応する require...() メソッドと一致している

getHelpText()

ルールのヘルプテキストを取得します。ヘルプテキストが設定されていない場合は null を取得します。

戻る

String - ルールのヘルプテキスト。ヘルプテキストが設定されていない場合は null。