Partager via


ExcelScript.RangeBorder interface

Cet objet représente la bordure d'un objet.

Méthode

getColor()

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

getSideIndex()

Valeur constante qui indique un côté spécifique de la bordure. Pour plus d’informations, consultez ExcelScript.BorderIndex .

getStyle()

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez ExcelScript.BorderLineStyle .

getTintAndShade()

Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de plage, la valeur est comprise entre -1 (plus foncé) et 1 (plus lumineux), avec 0 pour la couleur d’origine. Une null valeur indique que la bordure n’a pas de paramètre uniforme tintAndShade .

getWeight()

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez ExcelScript.BorderWeight .

setColor(color)

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

setStyle(style)

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez ExcelScript.BorderLineStyle .

setTintAndShade(tintAndShade)

Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de plage, la valeur est comprise entre -1 (plus foncé) et 1 (plus lumineux), avec 0 pour la couleur d’origine. Une null valeur indique que la bordure n’a pas de paramètre uniforme tintAndShade .

setWeight(weight)

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez ExcelScript.BorderWeight .

Détails de la méthode

getColor()

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

getColor(): string;

Retourne

string

getSideIndex()

Valeur constante qui indique un côté spécifique de la bordure. Pour plus d’informations, consultez ExcelScript.BorderIndex .

getSideIndex(): BorderIndex;

Retourne

getStyle()

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez ExcelScript.BorderLineStyle .

getStyle(): BorderLineStyle;

Retourne

getTintAndShade()

Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de plage, la valeur est comprise entre -1 (plus foncé) et 1 (plus lumineux), avec 0 pour la couleur d’origine. Une null valeur indique que la bordure n’a pas de paramètre uniforme tintAndShade .

getTintAndShade(): number;

Retourne

number

getWeight()

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez ExcelScript.BorderWeight .

getWeight(): BorderWeight;

Retourne

setColor(color)

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

setColor(color: string): void;

Paramètres

color

string

Retourne

void

setStyle(style)

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez ExcelScript.BorderLineStyle .

setStyle(style: BorderLineStyle): void;

Paramètres

Retourne

void

Exemples

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

Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de plage, la valeur est comprise entre -1 (plus foncé) et 1 (plus lumineux), avec 0 pour la couleur d’origine. Une null valeur indique que la bordure n’a pas de paramètre uniforme tintAndShade .

setTintAndShade(tintAndShade: number): void;

Paramètres

tintAndShade

number

Retourne

void

setWeight(weight)

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez ExcelScript.BorderWeight .

setWeight(weight: BorderWeight): void;

Paramètres

Retourne

void

Exemples

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