GASでスプレッドシートの枠線を設定する方法【Google Apps Script】

スプレッドシートを使っていると、枠線を設定する機会が多々あります。

こんな経験ありませんか？

メニューバーから手動で枠線を設定するのが面倒
行や列が追加されるたびに枠線を引き直している
枠線の色や太さを変えるのが面倒

メニューバーを操作して手動で枠線を作る事もできますが、枠線を設定する範囲が変化したり、条件にあわせて枠線の引き方を変えたい場合にはGASを使うと便利です。

この記事では、GASを使って枠線を設定する方法をご紹介します。

こんな人におすすめ

GASで枠線を設定する方法を知りたい
行や列が追加されても確実に枠線を設定したい
条件にあわせて枠線の色や太さを自動的に変えたい

はじめに
① 枠線のみを設定する方法
② 枠線の設定に加えて色やスタイルまで設定する方法
1. colorの設定方法
2. styleの設定方法
  1. style設定時の注意点
まとめ

はじめに

枠線の設定方法には、大きく分けて2つの方法があります。

『枠線のみを設定する方法』と『枠線の設定に加えて、枠線の色やスタイルまで設定する方法』です。

以下の図の通り、Google Workspace公式ページで詳細な解説がされているので順番に見ていきましょう。

① 枠線のみを設定する方法

枠線のみを設定したい場合の構文は以下のとおりです。

構文：Rangeオブジェクト.setBorder(top,left,bottom,right,vertical,horizontal)

Rangeオブジェクトというのは、セル範囲を指定している変数だと思って下さい。

一般的には”range”という変数名を使うことが多いですが、公式ページから引用したサンプルコードでは”cell”という変数名を使っているようです↓

function myFunction() {
//Google Workspace公式ページから引用
 var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);
}

いずれにせよ、セル範囲（公式の例ではB2セル）を指定している変数だということに変わりはありませんのでお気になさらず。

詳しく知りたい方は、こちらの記事をご参照下さい↓

GAS初心者必見！スプレッドシートの構造とコードの書き方【Google Apps Script】

GASでスプレッドシートを動かしたいというそこのあなた！コードの書き方で悩んでいませんか？こんな経験ありませんか？ネットで調べてみたけど意味が分からないコピペしたのに動かないコードの修正や応用が出来ない...

ところで、重要なのは括弧内の(top,left,bottom,right,vertical,horizontal)です。

それぞれが示す枠線は以下の図のとおりです↓

以下のリファレンスでも解説されていますが、それぞれの枠線はtrueまたはfalseで設定します。（Boolean:ブーリアンとはtrue/falseで表すデータ型です）

https://developers.google.com/apps-script/reference/spreadsheet/range?hl=ja#setBorder(Boolean,Boolean,Boolean,Boolean,Boolean,Boolean)

trueとすれば枠線が設定され、falseの場合は枠線は設定されません。nullは元の設定を保持する場合に使用します。

ですので、上のサンプルコードを実行すると以下のように上下の枠線のみが設定されます↓

ちなみに、verticalとhorizontalはセルの範囲が複数にまたがる場合のみ有効です。（上のサンプルコードでは指定範囲がB2セル単体なので、仮にvertical, horizontalをtrueにしても何も起こりません）

② 枠線の設定に加えて色やスタイルまで設定する方法

①と大きく変わるところは、枠線の色とスタイルも設定できるというところです。

構文は以下のとおりです。

構文：Rangeオブジェクト.setBorder(top,left,bottom,right,vertical,horizontal,color,style)

color, style以外の設定方法は、先程の①と同様です。

以下は公式ページから引用したサンプルコードですが、colorをred、styleをDASHEDとしていますね。

function myFunction() {
//Google Workspace公式ページから引用
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);
}

ちなみに、上のサンプルコードを実行するとB2セルの枠線は以下の図のようになります↓