ExcelScript.RangeBorder interface

包:

ExcelScript

代表对象的边框。

方法

getColor()	表示边框线颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (例如“橙色”) 。
getSideIndex()	指示边框的特定边的常量值。 有关详细信息，请参阅 ExcelScript.BorderIndex。
getStyle()	线条样式的常量之一，指定边框的线条样式。 有关详细信息，请参阅 ExcelScript.BorderLineStyle。
getTintAndShade()	指定为范围边框的颜色变亮或变暗的双精度值，该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示边框没有统 tintAndShade 一设置。
getWeight()	指定区域周围的边框的粗细。 有关详细信息，请参阅 ExcelScript.BorderWeight。
setColor(color)	表示边框线颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (例如“橙色”) 。
setStyle(style)	线条样式的常量之一，指定边框的线条样式。 有关详细信息，请参阅 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()

线条样式的常量之一，指定边框的线条样式。 有关详细信息，请参阅 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)

线条样式的常量之一，指定边框的线条样式。 有关详细信息，请参阅 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);
}