ExcelScript.RangeBorder interface

Paquete:

ExcelScript

Representa el borde de un objeto.

Métodos

getColor()	Código de color HTML que representa el color de la línea de borde, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
getSideIndex()	Valor constante que indica el lado específico del borde. Vea ExcelScript.BorderIndex para más información.
getStyle()	Una de las constantes de estilo de línea que especifica el estilo de línea del borde. Vea ExcelScript.BorderLineStyle para más información.
getTintAndShade()	Especifica un doble que aclara u oscurece un color para el borde del intervalo, el valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el borde no tiene una configuración uniforme tintAndShade .
getWeight()	Especifica el grosor del borde que rodea un rango. Vea ExcelScript.BorderWeight para más información.
setColor(color)	Código de color HTML que representa el color de la línea de borde, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
setStyle(style)	Una de las constantes de estilo de línea que especifica el estilo de línea del borde. Vea ExcelScript.BorderLineStyle para más información.
setTintAndShade(tintAndShade)	Especifica un doble que aclara u oscurece un color para el borde del intervalo, el valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el borde no tiene una configuración uniforme tintAndShade .
setWeight(weight)	Especifica el grosor del borde que rodea un rango. Vea ExcelScript.BorderWeight para más información.

Detalles del método

getColor()

Código de color HTML que representa el color de la línea de borde, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").

getColor(): string;

Devoluciones

string

getSideIndex()

Valor constante que indica el lado específico del borde. Vea ExcelScript.BorderIndex para más información.

getSideIndex(): BorderIndex;

Devoluciones

ExcelScript.BorderIndex

getStyle()

Una de las constantes de estilo de línea que especifica el estilo de línea del borde. Vea ExcelScript.BorderLineStyle para más información.

getStyle(): BorderLineStyle;

Devoluciones

ExcelScript.BorderLineStyle

getTintAndShade()

Especifica un doble que aclara u oscurece un color para el borde del intervalo, el valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el borde no tiene una configuración uniforme tintAndShade .

getTintAndShade(): number;

Devoluciones

number

getWeight()

Especifica el grosor del borde que rodea un rango. Vea ExcelScript.BorderWeight para más información.

getWeight(): BorderWeight;

Devoluciones

ExcelScript.BorderWeight

setColor(color)

Código de color HTML que representa el color de la línea de borde, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").

setColor(color: string): void;

Parámetros

color

string

Devoluciones

void

setStyle(style)

Una de las constantes de estilo de línea que especifica el estilo de línea del borde. Vea ExcelScript.BorderLineStyle para más información.

setStyle(style: BorderLineStyle): void;

Parámetros

style

ExcelScript.BorderLineStyle

Devoluciones

void

Ejemplos

/**
 * 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)

Especifica un doble que aclara u oscurece un color para el borde del intervalo, el valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el borde no tiene una configuración uniforme tintAndShade .

setTintAndShade(tintAndShade: number): void;

Parámetros

tintAndShade

number

Devoluciones

void

setWeight(weight)

Especifica el grosor del borde que rodea un rango. Vea ExcelScript.BorderWeight para más información.

setWeight(weight: BorderWeight): void;

Parámetros

weight

ExcelScript.BorderWeight

Devoluciones

void

Ejemplos

/**
 * 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);
}