[GAS]セルのテキストの折り返し設定を取得・設定する方法 -Rangeクラス-

Google Apps Script (GAS) でこのセル範囲のセルのテキストの折り返し設定を取得・設定する方法を説明します。

Rangeクラスのメソッドを利用した手順について説明します。

Google Apps Scriptの基本的な使い方については下記をご覧ください。

GASによるスプレッドシート操作の概要

GASでスプレッドシートを操作するための「SpreadSheetサービス」は、主に下記のクラスで構成されています。

クラス	説明
SpreadSheetApp	SpreadSheetサービスの親クラス
Spreadsheet	スプレッドシートを操作するクラス
Sheet	シートを操作するクラス
Range	セル範囲を操作するクラス

それぞれ下記のような位置付けになります。

「SpreadSheetApp」→「SpreadSheet」→「Sheet」→「Range」という順の階層構造になっています。操作対象に応じて、下の階層にたどってオブジェクトを取得して利用します。

このページでは、上記の中のRangeクラスの下記のメソッドについて説明します。

メソッド	戻り値	説明
getWrap()	Boolean	このセル範囲の左上のセルのテキストが折り返す設定かどうかを取得する
getWraps()	Boolean[][]	このセル範囲のセルのテキストが折り返す設定かどうかを配列で一括取得する
setWrap(isWrapEnabled)	Range	このセル範囲のセルのテキストが折り返す設定かどうかを設定する
setWraps(isWrapEnabled)	Range	このセル範囲のセルのテキストが折り返す設定かどうかを配列で一括設定する
getWrapStrategy()	WrapStrategy	このセル範囲の左上のセルのテキストの折り返し設定を取得する
getWrapStrategies()	WrapStrategy[][]	このセル範囲のセルのテキストの折り返し設定を配列で一括取得する
setWrapStrategy(strategy)	Range	このセル範囲のセルのテキストの折り返し設定を一括設定する
setWrapStrategies(strategies)	Range	このセル範囲のセルのテキストの折り返し設定を配列で一括設定する

このセル範囲のセルのテキストが折り返す設定かどうかを取得・設定する：

このセル範囲のセルのテキストが折り返す設定になっているかどうかを取得・設定するメソッドを説明します。

スプレッドシートの折り返し設定には下記の3種類があります。

この章で説明するメソッドは、「折り返しあり」になっているかどうかのみを取得・設定します。切り詰めの設定になっているかどうかの取得・設定をしたい場合は、「このセル範囲のセルのテキストの折り返し設定を取得・設定する」の章をご覧ください。

このセル範囲の左上のセルのテキストが折り返す設定かどうかを取得する：getWrap()

このセル範囲の左上のセルのテキストが折り返す設定になっているかどうかを取得する方法です。

折り返す設定になっている場合はtrue、そうでない場合はfalseを返します。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  console.log(testRange.getWrap());
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

console.log(testRange.getWrap());

}

下記のような実行結果になります。左上セルのテキストが折り返す設定になっているかどうかを取得できます。

true

true

このセル範囲のセルのテキストが折り返す設定かどうかを配列で一括取得する：getWraps()

このセル範囲のセルのテキストが折り返す設定になっているかどうかを配列で一括取得する方法です。

折り返す設定になっている場合はtrue、そうでない場合はfalseを返します。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  console.log(testRange.getWraps());
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

console.log(testRange.getWraps());

}

下記のような実行結果になります。セルのテキストが折り返す設定になっているかどうかを配列で一括取得できます。

[ [ true, false ], [ false, false ] ]

1	[ [ true, false ], [ false, false ] ]

このセル範囲のセルのテキストが折り返す設定かどうかを設定する：setWrap(isWrapEnabled)

このセル範囲のセルのテキストを折り返すかどうかを一括設定する方法です。

折り返す設定にする場合はtrue、折り返しなしにする場合はfalseを指定します。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  testRange.setWrap(false);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

testRange.setWrap(false);

}

下記のファイルで実行してみます。

下記のような実行結果になります。セルのテキストを折り返すかどうかを一括設定できます。falseにすると切り詰めも解除されます。

このセル範囲のセルのテキストが折り返す設定かどうかを配列で一括設定する：setWraps(isWrapEnabled)

このセル範囲のセルのテキストを折り返すかどうかを配列で一括設定する方法です。

折り返す設定にする場合はtrue、折り返しなしにする場合はfalseを指定します。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  testRange.setWraps([[false, false], [true, false]]);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

testRange.setWraps([[false, false], [true, false]]);

}

下記のファイルで実行してみます。

下記のような実行結果になります。セルのテキストを折り返すかどうかを配列で一括設定できます。falseにすると切り詰めも解除されます。

このセル範囲のセルのテキストの折り返し設定を取得・設定する

このセル範囲のセルのテキストの折り返し設定を取得・設定するメソッドを説明します。

スプレッドシートの折り返し設定には下記の3種類があります。この章で説明するメソッドは、下記の3種類の設定の取得・設定を行います。

このセル範囲の左上のセルのテキストの折り返し設定を取得する：getWrapStrategy()

このセル範囲の左上のセルのテキストの折り返し設定を取得する方法です。

戻り値は、下記のいずれかになります。

設定	戻り値
折り返しなし	OVERFLOW
折り返しあり	WRAP
切り詰め	CLIP

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  console.log(testRange.getWrapStrategy().toString());
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

console.log(testRange.getWrapStrategy().toString());

}

下記のような実行結果になります。左上セルのテキストの折り返し設定を取得できます。

WRAP

WRAP

このセル範囲のセルのテキストの折り返し設定を配列で一括取得する：getWrapStrategies()

このセル範囲のセルのテキストの折り返し設定を配列で一括取得する方法です。

戻り値は、下記のいずれかになります。

設定	戻り値
折り返しなし	OVERFLOW
折り返しあり	WRAP
切り詰め	CLIP

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  const testWrapStrategy = testRange.getWrapStrategies();
  for (const rows of testWrapStrategy) {
    for (const cell of rows) {
      console.log(cell.toString());
    }
  }
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

const testWrapStrategy = testRange.getWrapStrategies();

for (const rows of testWrapStrategy) {

for (const cell of rows) {

console.log(cell.toString());

}

下記のような実行結果になります。セルのテキストの折り返し設定を配列で一括取得できます。

WRAP
CLIP
OVERFLOW
OVERFLOW

WRAP

CLIP

OVERFLOW

このセル範囲のセルのテキストの折り返し設定を一括設定する：setWrapStrategy(strategy)

このセル範囲のセルのテキストの折り返し設定を一括設定する方法です。

引数は下記のいずれかの設定を指定します。

設定	折り返し設定
SpreadsheetApp.WrapStrategy.OVERFLOW	折り返しなし
SpreadsheetApp.WrapStrategy.WRAP	折り返しあり
SpreadsheetApp.WrapStrategy.CLIP	切り詰め

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  testRange.setWrapStrategy(SpreadsheetApp.WrapStrategy.WRAP);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

testRange.setWrapStrategy(SpreadsheetApp.WrapStrategy.WRAP);

}

下記のファイルで実行してみます。

下記のような実行結果になります。セルのテキストの折り返し設定を一括設定できます。

このセル範囲のセルのテキストの折り返し設定を配列で一括設定する：setWrapStrategies(strategies)

このセル範囲のセルのテキストの折り返し設定を配列で一括設定する方法です。

引数は下記のいずれかの設定を指定します。

設定	折り返し設定
SpreadsheetApp.WrapStrategy.OVERFLOW	折り返しなし
SpreadsheetApp.WrapStrategy.WRAP	折り返しあり
SpreadsheetApp.WrapStrategy.CLIP	切り詰め

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  const testRange = testSheet.getRange("B2:C3");
  testRange.setWrapStrategies([[SpreadsheetApp.WrapStrategy.OVERFLOW, SpreadsheetApp.WrapStrategy.OVERFLOW], [SpreadsheetApp.WrapStrategy.WRAP, SpreadsheetApp.WrapStrategy.CLIP]]);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

const testRange = testSheet.getRange("B2:C3");

testRange.setWrapStrategies([[SpreadsheetApp.WrapStrategy.OVERFLOW, SpreadsheetApp.WrapStrategy.OVERFLOW], [SpreadsheetApp.WrapStrategy.WRAP, SpreadsheetApp.WrapStrategy.CLIP]]);

}

下記のファイルで実行してみます。