ExcelScript.RangeBorder interface

Pacote:

ExcelScript

Representa a borda de um objeto.

Métodos

getColor()	Código de cores HTML que representa a cor da linha de limite, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
getSideIndex()	Valor constante que indica o lado específico da borda. Veja ExcelScript.BorderIndex para obter detalhes.
getStyle()	Uma das constantes de estilo de linha especificando o estilo de linha da borda. Veja ExcelScript.BorderLineStyle para obter detalhes.
getTintAndShade()	Especifica um duplo que ilumina ou escurece uma cor para o limite do intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o limite não tem uma definição uniforme tintAndShade .
getWeight()	Especifica o peso da borda em torno de um intervalo. Veja ExcelScript.BorderWeight para obter detalhes.
setColor(color)	Código de cores HTML que representa a cor da linha de limite, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
setStyle(style)	Uma das constantes de estilo de linha especificando o estilo de linha da borda. Veja ExcelScript.BorderLineStyle para obter detalhes.
setTintAndShade(tintAndShade)	Especifica um duplo que ilumina ou escurece uma cor para o limite do intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o limite não tem uma definição uniforme tintAndShade .
setWeight(weight)	Especifica o peso da borda em torno de um intervalo. Veja ExcelScript.BorderWeight para obter detalhes.

Detalhes do método

getColor()

Código de cores HTML que representa a cor da linha de limite, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

getColor(): string;

Retornos

string

getSideIndex()

Valor constante que indica o lado específico da borda. Veja ExcelScript.BorderIndex para obter detalhes.

getSideIndex(): BorderIndex;

Retornos

ExcelScript.BorderIndex

getStyle()

Uma das constantes de estilo de linha especificando o estilo de linha da borda. Veja ExcelScript.BorderLineStyle para obter detalhes.

getStyle(): BorderLineStyle;

Retornos

ExcelScript.BorderLineStyle

getTintAndShade()

Especifica um duplo que ilumina ou escurece uma cor para o limite do intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o limite não tem uma definição uniforme tintAndShade .

getTintAndShade(): number;

Retornos

number

getWeight()

Especifica o peso da borda em torno de um intervalo. Veja ExcelScript.BorderWeight para obter detalhes.

getWeight(): BorderWeight;

Retornos

ExcelScript.BorderWeight

setColor(color)

Código de cores HTML que representa a cor da linha de limite, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

setColor(color: string): void;

Parâmetros

color

string

Retornos

void

setStyle(style)

Uma das constantes de estilo de linha especificando o estilo de linha da borda. Veja ExcelScript.BorderLineStyle para obter detalhes.

setStyle(style: BorderLineStyle): void;

Parâmetros

style

ExcelScript.BorderLineStyle

Retornos

void

Exemplos

/**
 * 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 um duplo que ilumina ou escurece uma cor para o limite do intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o limite não tem uma definição uniforme tintAndShade .

setTintAndShade(tintAndShade: number): void;

Parâmetros

tintAndShade

number

Retornos

void

setWeight(weight)

Especifica o peso da borda em torno de um intervalo. Veja ExcelScript.BorderWeight para obter detalhes.

setWeight(weight: BorderWeight): void;

Parâmetros

weight

ExcelScript.BorderWeight

Retornos

void

Exemplos

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