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 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“orange”)
getPattern()	范围的模式。 有关详细信息，请参阅 ExcelScript.FillPattern。 不支持 LinearGradient 和 RectangularGradient。 值 null 指示整个范围没有统一模式设置。
getPatternColor()	表示范围图案颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (，例如“橙色”) 。
getPatternTintAndShade()	指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。
getTintAndShade()	指定一个使范围填充的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 tintAndShade 设置。
setColor(color)	表示背景颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“orange”)
setPattern(pattern)	范围的模式。 有关详细信息，请参阅 ExcelScript.FillPattern。 不支持 LinearGradient 和 RectangularGradient。 值 null 指示整个范围没有统一模式设置。
setPatternColor(patternColor)	表示范围图案颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (，例如“橙色”) 。
setPatternTintAndShade(patternTintAndShade)	指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。
setTintAndShade(tintAndShade)	指定一个使范围填充的颜色变浅或变暗的双精度值。 该值介于 -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 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“orange”)

getColor(): string;

返回

string

getPattern()

范围的模式。 有关详细信息，请参阅 ExcelScript.FillPattern。 不支持 LinearGradient 和 RectangularGradient。 值 null 指示整个范围没有统一模式设置。

getPattern(): FillPattern;

返回

ExcelScript.FillPattern

getPatternColor()

表示范围图案颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (，例如“橙色”) 。

getPatternColor(): string;

返回

string

getPatternTintAndShade()

指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。

getPatternTintAndShade(): number;

返回

number

getTintAndShade()

指定一个使范围填充的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 tintAndShade 设置。

getTintAndShade(): number;

返回

number

setColor(color)

表示背景颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“orange”)

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)

指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。

setPatternTintAndShade(patternTintAndShade: number): void;

参数

patternTintAndShade

number

返回

void

setTintAndShade(tintAndShade)

指定一个使范围填充的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 tintAndShade 设置。

setTintAndShade(tintAndShade: number): void;

参数

tintAndShade

number

返回

void