ExcelScript.RangeBorder interface

Paket:

ExcelScript

Stellt den Rahmen eines Objekts dar.

Methoden

getColor()	HTML-Farbcode, der die Farbe der Rahmenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.
getSideIndex()	Konstanter Wert, der die bestimmte Seiten des Rahmens angibt. Weitere Informationen finden Sie unter ExcelScript.BorderIndex .
getStyle()	Einer der Konstanten der Linienart, die die Linienart für den Rahmen angibt. Weitere Informationen finden Sie unter ExcelScript.BorderLineStyle .
getTintAndShade()	Gibt ein Double an, das eine Farbe für den Bereichsrahmen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellsten) und 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Rahmen keine einheitliche tintAndShade Einstellung aufweist.
getWeight()	Gibt die Stärke des Rahmens um einen Bereich an. Weitere Informationen finden Sie unter ExcelScript.BorderWeight .
setColor(color)	HTML-Farbcode, der die Farbe der Rahmenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.
setStyle(style)	Einer der Konstanten der Linienart, die die Linienart für den Rahmen angibt. Weitere Informationen finden Sie unter ExcelScript.BorderLineStyle .
setTintAndShade(tintAndShade)	Gibt ein Double an, das eine Farbe für den Bereichsrahmen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellsten) und 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Rahmen keine einheitliche tintAndShade Einstellung aufweist.
setWeight(weight)	Gibt die Stärke des Rahmens um einen Bereich an. Weitere Informationen finden Sie unter ExcelScript.BorderWeight .

Details zur Methode

getColor()

HTML-Farbcode, der die Farbe der Rahmenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.

getColor(): string;

Gibt zurück

string

getSideIndex()

Konstanter Wert, der die bestimmte Seiten des Rahmens angibt. Weitere Informationen finden Sie unter ExcelScript.BorderIndex .

getSideIndex(): BorderIndex;

Gibt zurück

ExcelScript.BorderIndex

getStyle()

Einer der Konstanten der Linienart, die die Linienart für den Rahmen angibt. Weitere Informationen finden Sie unter ExcelScript.BorderLineStyle .

getStyle(): BorderLineStyle;

Gibt zurück

ExcelScript.BorderLineStyle

getTintAndShade()

Gibt ein Double an, das eine Farbe für den Bereichsrahmen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellsten) und 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Rahmen keine einheitliche tintAndShade Einstellung aufweist.

getTintAndShade(): number;

Gibt zurück

number

getWeight()

Gibt die Stärke des Rahmens um einen Bereich an. Weitere Informationen finden Sie unter ExcelScript.BorderWeight .

getWeight(): BorderWeight;

Gibt zurück

ExcelScript.BorderWeight

setColor(color)

HTML-Farbcode, der die Farbe der Rahmenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.

setColor(color: string): void;

Parameter

color

string

Gibt zurück

void

setStyle(style)

Einer der Konstanten der Linienart, die die Linienart für den Rahmen angibt. Weitere Informationen finden Sie unter ExcelScript.BorderLineStyle .

setStyle(style: BorderLineStyle): void;

Parameter

style

ExcelScript.BorderLineStyle

Gibt zurück

void

Beispiele

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

Gibt ein Double an, das eine Farbe für den Bereichsrahmen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellsten) und 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Rahmen keine einheitliche tintAndShade Einstellung aufweist.

setTintAndShade(tintAndShade: number): void;

Parameter

tintAndShade

number

Gibt zurück

void

setWeight(weight)

Gibt die Stärke des Rahmens um einen Bereich an. Weitere Informationen finden Sie unter ExcelScript.BorderWeight .

setWeight(weight: BorderWeight): void;

Parameter

weight

ExcelScript.BorderWeight

Gibt zurück

void

Beispiele

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