【GAS】スプレッドシートのチェックボックス機能まとめ【サンプルソース付】

GAS開発者向けにスプレッドシートのチェックボックス機能をすべてまとめました。

データの選択判断させたい場合、チェックボックスはわかりやすく超有効なインターフェースですね。

GASで動的にデータに併せてチェックボックスON･OFFをコントロールできれば、いろいろ融通が利くはずなので、ぜひ活用してみてください。

チェックボックスに関するメソッドをすべて載せてます。少しでも参考になれば幸いです。

Google Apps Script スプレッドシート基礎リファレンス
セル範囲クラス[Range]のチェックボックス
セル範囲リストクラス[RangeList]のチェックボックス
最後に

Google Apps Script スプレッドシート基礎リファレンス

当ページは、GAS公式リファレンスを元にスプレッドシートの機能毎にまとめた基礎的な内容となっております。

若干、文言がおかしい可能性がありますが、あらかじめご了承ください。

GAS基本メソッドまとめ一覧はコチラ↓↓↓です。スプレッドシートの基本的な機能をまとめてますので、ぜひご活用ください。

【GAS】スプレッドシート基本メソッドまとめ一覧【初心者入門】

GAS開発者向けにスプレッドシートの基本的なメソッドを一覧にまとめました。各機能ごとのクラス、メソッドごとのサンプルソース付ページへリンクする一覧です。初心者にとって、スプレッドシートの基本的な操作・機能単位のメソッドを知...

まずは実際に動かしてみることをオススメします。マクロの登録方法は以下を参照いただければと思います。

【GAS】Googleスプレッドシートでマクロの使い方入門【動画付】

Googleの「Google Apps Script」通称GAS。GoogleマップやGメールなど、いろんなGoogle関連のサービスと自由に連携できたり、独自のWebアプリを開発することもできる、いろんな可能性を秘めたワクワクの...

GASの本はまだまだ少ないですね。基礎レベルであれば、以下の参考書が初心者にはベストの本です。

基本的な仕様やよく使われる機能の設定方法がまとまっています。

リンク

※JavaScriptの知識が既にある程度ある人にとっては冗長かもしれません。

セル範囲クラス[Range]のチェックボックス

セル範囲のチェックボックスメソッドです。

チェックボックス挿入1[insertCheckboxes()]

insertCheckboxes()
範囲内の各セルにチェックボックスを挿入します。チェックマークが付いている場合はtrue、チェックマークが付いていない場合はfalseに設定されています。範囲内のすべてのセルの値をfalseに設定します。

function insertCheckboxes1Sample() {
  var range = SpreadsheetApp.getActive().getRange('A1:B10');

  // チェックボックスが「true」、チェックマークが付いていない場合は「false」で設定されたA1:B10の範囲の各セルに
  // チェックボックスを挿入します。また、A1:B10の範囲の各セルの値を 'false'に設定します。
  range.insertCheckboxes();
}

Return
Range - 連鎖用のセル範囲。

チェックボックス挿入2[insertCheckboxes(チェック値)]

insertCheckboxes(checkedValue)
チェックボックスのカスタム値とチェックボックスの空の文字列で設定された範囲内の各セルにチェックボックスを挿入します。範囲内の各セルの値を空の文字列に設定します。

function insertCheckboxes2Sample() {
  var range = SpreadsheetApp.getActive().getRange('A1:B10');

  // チェックマークが 'yes'、チェックマークが付いていない空文字列で設定されたA1:B10の範囲の各セルに
  // チェックボックスを挿入します。また、A1:B10の範囲の各セルの値を空の文字列に設定します。
  range.insertCheckboxes('yes');
}

Parameters
名前	タイプ	説明
checkedValue	Object	チェックボックスデータ検証のチェック値。

Return
Range - 連鎖用のセル範囲。

チェックボックス挿入3[insertCheckboxes(チェック値, チェックされていない値)]

insertCheckboxes(checkedValue, uncheckedValue)
チェック状態と未チェック状態のカスタム値で設定された範囲内の各セルにチェックボックスを挿入します。範囲内の各セルの値をカスタムの未チェックの値に設定します。

function insertCheckboxes3Sample() {
  var range = SpreadsheetApp.getActive().getRange('A1:B10');

  // チェックボックスが 'yes'、チェックボックスが 'no'に設定されているA1:B10の範囲の各セルに
  // チェックボックスを挿入します。また、A1:B10の範囲内の各セルの値を 'no'に設定します。
  range.insertCheckboxes('yes', 'no');
}

Parameters
名前	タイプ	説明
checkedValue	Object	チェックボックスデータ検証のチェック値。
uncheckedValue	Object	チェックボックスデータ検証のチェックされていない値。

Return
Range - 連鎖用のセル範囲。

チェックボックス削除[removeCheckboxes()]

removeCheckboxes()
範囲からすべてのチェックボックスを削除します。各セルのデータ検証をクリアし、セルにチェック済みまたは未チェックの値が含まれている場合はさらにその値をクリアします。

function removeCheckboxesSample() {
  var range = SpreadsheetApp.getActive().getRange('A1:B10');

  // チェックボックスを挿入し、各セルの値をA1:B10の範囲の 'no'に設定します。
  range.insertCheckboxes('yes', 'no');

  var range1 = SpreadsheetApp.getActive().getRange('A1');
  range1.setValue('yes');
  // セルA1のチェックボックスデータ検証を削除し、その値をクリアします。
  range1.removeCheckboxes();

  var range2 = SpreadsheetApp.getActive().getRange('A2');
  range2.setValue('random');
  // セルA2のチェックボックスデータの検証を削除しますが、値をクリアしません。
  range2.removeCheckboxes();
}

Return
Range - 連鎖用のセル範囲。

チェックボックスオン[check()]

check()
範囲内のチェックボックスの状態を "checked"に変更します。現在設定されているチェック値またはチェックされていない値を含まない範囲のセルを無視します。

function checkSample() {
  // 現在A1:B10の範囲で設定されたチェック済み
  // または未チェックの値を含むセルの状態を 'checked'に変更します。
  var range = SpreadsheetApp.getActive().getRange('A1:B10');
  range.check();
}

Return
Range - 連鎖用のセル範囲。

チェックボックスオフ[uncheck()]

uncheck()
範囲内のチェックボックスの状態を「未チェック」に変更します。現在設定されているチェック値またはチェックされていない値を含まない範囲のセルを無視します。

function uncheckSample() {
  // 現在A1:B10の範囲で設定されたチェック済み
  // または未チェックの値を含むセルの状態を 'unchecked'に変更します。
  var range = SpreadsheetApp.getActive().getRange('A1:B10');
  range.uncheck();
}

Return
Range - 連鎖用のセル範囲。

チェックボックス状態確認[isChecked()]

isChecked()
範囲内のすべてのセルのチェックボックスの状態が 'checked'になっているかどうかを返します。一部のセルがチェックされ、残りがチェックされていない場合、または一部のセルにチェックボックスデータの検証がない場合はnullを返します。

function isCheckedSample() {
  var range = SpreadsheetApp.getActive().getRange('A1:A3');

  // チェックボックスを挿入し、各セルの値をA1:A3の範囲で 'no'に設定します。
  range.insertCheckboxes('yes', 'no');

  var range1 = SpreadsheetApp.getActive().getRange('A1');
  range1.setValue('yes');
  // isRange1Checkedの値にチェックされた値が含まれているため、trueに設定します。
  var isRange1Checked = range1.isChecked();

  var range2 = SpreadsheetApp.getActive().getRange('A2');
  range2.setValue('no');
  // isRange2Checkedの値に未チェックの値が含まれているため、falseに設定します。
  var isRange2Checked = range2.isChecked();

  var range3 = SpreadsheetApp.getActive().getRange('A3');
  range3.setValue('random');
  // isRange3Checkedの値に無効なチェックボックス値が含まれているため、nullに設定します。
  var isRange3Checked = range3.isChecked();
}

Return
Boolean - 範囲内のすべてのセルがチェックされている場合はtrue、範囲内のすべてのセルがチェックされていない場合はfalse、いずれかのセルがチェックされていない、またはチェックボックスデータ検証がない場合はnullです。