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