ExcelScript.RangeBorder interface

パッケージ:

ExcelScript

オブジェクトの輪郭を表します。

メソッド

getColor()	境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。
getSideIndex()	罫線の特定の辺を表す定数値。 詳細は「ExcelScript.BorderIndex」をご覧ください。
getStyle()	罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。 詳細は「ExcelScript.BorderLineStyle」をご覧ください。
getTintAndShade()	範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、境界線に均一なtintAndShade設定がないことを示します。
getWeight()	範囲周辺の罫線の太さを指定します。 詳細は「ExcelScript.BorderWeight」をご覧ください。
setColor(color)	境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。
setStyle(style)	罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。 詳細は「ExcelScript.BorderLineStyle」をご覧ください。
setTintAndShade(tintAndShade)	範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、境界線に均一なtintAndShade設定がないことを示します。
setWeight(weight)	範囲周辺の罫線の太さを指定します。 詳細は「ExcelScript.BorderWeight」をご覧ください。

メソッドの詳細

getColor()

境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。

getColor(): string;

戻り値

string

getSideIndex()

罫線の特定の辺を表す定数値。 詳細は「ExcelScript.BorderIndex」をご覧ください。

getSideIndex(): BorderIndex;

戻り値

ExcelScript.BorderIndex

getStyle()

罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。 詳細は「ExcelScript.BorderLineStyle」をご覧ください。

getStyle(): BorderLineStyle;

戻り値

ExcelScript.BorderLineStyle

getTintAndShade()

範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、境界線に均一なtintAndShade設定がないことを示します。

getTintAndShade(): number;

戻り値

number

getWeight()

範囲周辺の罫線の太さを指定します。 詳細は「ExcelScript.BorderWeight」をご覧ください。

getWeight(): BorderWeight;

戻り値

ExcelScript.BorderWeight

setColor(color)

境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。

setColor(color: string): void;

パラメーター

color

string

戻り値

void

setStyle(style)

罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。 詳細は「ExcelScript.BorderLineStyle」をご覧ください。

setStyle(style: BorderLineStyle): void;

パラメーター

style

ExcelScript.BorderLineStyle

戻り値

void

例

/**
 * This script adds a border around the outside of a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a range from the current worksheet.
  let range = workbook.getActiveWorksheet().getRange("B2:E15");

  // Add a border around the whole bounding range.
  let format = range.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

setTintAndShade(tintAndShade)

範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、境界線に均一なtintAndShade設定がないことを示します。

setTintAndShade(tintAndShade: number): void;

パラメーター

tintAndShade

number

戻り値

void

setWeight(weight)

範囲周辺の罫線の太さを指定します。 詳細は「ExcelScript.BorderWeight」をご覧ください。

setWeight(weight: BorderWeight): void;

パラメーター

weight

ExcelScript.BorderWeight

戻り値

void

例

/**
 * This script creates a border around a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the RangeFormat object for the range "B2:G10".
  const currentSheet = workbook.getActiveWorksheet();
  const rangeForBorder = currentSheet.getRange("B2:G10");
  const format = rangeForBorder.getFormat();
  
  // Get a RangeBorder object for each edge of the range and set the border properties.
  let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
  edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
  edgeTop.setWeight(ExcelScript.BorderWeight.thick);

  let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
  edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
  edgeBottom.setWeight(ExcelScript.BorderWeight.thick);

  let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
  edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
  edgeLeft.setWeight(ExcelScript.BorderWeight.thick);

  let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
  edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
  edgeRight.setWeight(ExcelScript.BorderWeight.thick);
}