ExcelScript.RangeFill interface

パッケージ:

ExcelScript

Range オブジェクトの背景を表します。

注釈

例

/**
 * This script sets the fill color of the used range to green.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Get the RangeFill object.
  let fill = usedRange.getFormat().getFill();

  // Set the fill color to green.
  fill.setColor("green");
}

メソッド

clear()	範囲の背景をリセットします。
getColor()	背景の色を表す HTML カラー コード(例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") の形式で #RRGGBB
getPattern()	範囲のパターン。 詳細は「ExcelScript.FillPattern」をご覧ください。 LinearGradient と RectangularGradient はサポートされていません。 null値は、範囲全体に均一なパターン設定がないことを示します。
getPatternColor()	範囲パターンの色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML 色 (例: "オレンジ") として表されます。
getPatternTintAndShade()	範囲の塗りつぶしのパターンの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なpatternTintAndShade設定がないことを示します。
getTintAndShade()	範囲の塗りつぶしの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なtintAndShade設定がないことを示します。
setColor(color)	背景の色を表す HTML カラー コード(例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") の形式で #RRGGBB
setPattern(pattern)	範囲のパターン。 詳細は「ExcelScript.FillPattern」をご覧ください。 LinearGradient と RectangularGradient はサポートされていません。 null値は、範囲全体に均一なパターン設定がないことを示します。
setPatternColor(patternColor)	範囲パターンの色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML 色 (例: "オレンジ") として表されます。
setPatternTintAndShade(patternTintAndShade)	範囲の塗りつぶしのパターンの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なpatternTintAndShade設定がないことを示します。
setTintAndShade(tintAndShade)	範囲の塗りつぶしの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なtintAndShade設定がないことを示します。

メソッドの詳細

clear()

範囲の背景をリセットします。

clear(): void;

戻り値

void

例

/**
 * This script removes all fill color and styles from the used range.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Clear the fill from the entire range.
  usedRange.getFormat().getFill().clear();
}

getColor()

背景の色を表す HTML カラー コード(例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") の形式で #RRGGBB

getColor(): string;

戻り値

string

getPattern()

範囲のパターン。 詳細は「ExcelScript.FillPattern」をご覧ください。 LinearGradient と RectangularGradient はサポートされていません。 null値は、範囲全体に均一なパターン設定がないことを示します。

getPattern(): FillPattern;

戻り値

ExcelScript.FillPattern

getPatternColor()

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

getPatternColor(): string;

戻り値

string

getPatternTintAndShade()

範囲の塗りつぶしのパターンの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なpatternTintAndShade設定がないことを示します。

getPatternTintAndShade(): number;

戻り値

number

getTintAndShade()

範囲の塗りつぶしの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なtintAndShade設定がないことを示します。

getTintAndShade(): number;

戻り値

number

setColor(color)

背景の色を表す HTML カラー コード(例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") の形式で #RRGGBB

setColor(color: string): void;

パラメーター

color

string

戻り値

void

例

/**
 * This script sets the fill color of cell A2 to blue.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range representing cell A2 from the current worksheet.
  let cell = workbook.getActiveWorksheet().getRange("A2");

  // Set the fill color to blue.
  cell.getFormat().getFill().setColor("blue");
}

setPattern(pattern)

範囲のパターン。 詳細は「ExcelScript.FillPattern」をご覧ください。 LinearGradient と RectangularGradient はサポートされていません。 null値は、範囲全体に均一なパターン設定がないことを示します。

setPattern(pattern: FillPattern): void;

パラメーター

pattern

ExcelScript.FillPattern

戻り値

void

例

/**
 * This script sets a black-checkered fill on the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  const selected = workbook.getSelectedRange();
  selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
  selected.getFormat().getFill().setPatternColor("black");
}

setPatternColor(patternColor)

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

setPatternColor(patternColor: string): void;

パラメーター

patternColor

string

戻り値

void

setPatternTintAndShade(patternTintAndShade)

範囲の塗りつぶしのパターンの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なpatternTintAndShade設定がないことを示します。

setPatternTintAndShade(patternTintAndShade: number): void;

パラメーター

patternTintAndShade

number

戻り値

void

setTintAndShade(tintAndShade)

範囲の塗りつぶしの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲に一様なtintAndShade設定がないことを示します。

setTintAndShade(tintAndShade: number): void;

パラメーター

tintAndShade

number

戻り値

void