ExcelScript.RangeFill interface

Пакет:

ExcelScript

Представляет фон объекта диапазона.

Замечания

Примеры

/**
 * This script sets the fill color of the used range to green.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Get the RangeFill object.
  let fill = usedRange.getFormat().getFill();

  // Set the fill color to green.
  fill.setColor("green");
}

Методика

clear()	Сброс фона диапазона.
getColor()	Код цвета HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")
getPattern()	Шаблон диапазона. Дополнительные сведения см. в этой ExcelScript.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.
getPatternColor()	Код цвета HTML, представляющий цвет шаблона диапазона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
getPatternTintAndShade()	Задает двойник, который осветляет или затемняет цвет узора для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых patternTintAndShade параметров.
getTintAndShade()	Задает двойник, который осветляет или затемняет цвет заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых tintAndShade параметров.
setColor(color)	Код цвета HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")
setPattern(pattern)	Шаблон диапазона. Дополнительные сведения см. в этой ExcelScript.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.
setPatternColor(patternColor)	Код цвета HTML, представляющий цвет шаблона диапазона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
setPatternTintAndShade(patternTintAndShade)	Задает двойник, который осветляет или затемняет цвет узора для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых patternTintAndShade параметров.
setTintAndShade(tintAndShade)	Задает двойник, который осветляет или затемняет цвет заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых tintAndShade параметров.

Подробнее о методе

clear()

Сброс фона диапазона.

clear(): void;

Возвращает

void

Примеры

/**
 * This script removes all fill color and styles from the used range.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Clear the fill from the entire range.
  usedRange.getFormat().getFill().clear();
}

getColor()

Код цвета HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")

getColor(): string;

Возвращает

string

getPattern()

Шаблон диапазона. Дополнительные сведения см. в этой ExcelScript.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.

getPattern(): FillPattern;

Возвращает

ExcelScript.FillPattern

getPatternColor()

Код цвета HTML, представляющий цвет шаблона диапазона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

getPatternColor(): string;

Возвращает

string

getPatternTintAndShade()

Задает двойник, который осветляет или затемняет цвет узора для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых patternTintAndShade параметров.

getPatternTintAndShade(): number;

Возвращает

number

getTintAndShade()

Задает двойник, который осветляет или затемняет цвет заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых tintAndShade параметров.

getTintAndShade(): number;

Возвращает

number

setColor(color)

Код цвета HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")

setColor(color: string): void;

Параметры

color

string

Возвращает

void

Примеры

/**
 * This script sets the fill color of cell A2 to blue.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range representing cell A2 from the current worksheet.
  let cell = workbook.getActiveWorksheet().getRange("A2");

  // Set the fill color to blue.
  cell.getFormat().getFill().setColor("blue");
}

setPattern(pattern)

Шаблон диапазона. Дополнительные сведения см. в этой ExcelScript.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.

setPattern(pattern: FillPattern): void;

Параметры

pattern

ExcelScript.FillPattern

Возвращает

void

Примеры

/**
 * This script sets a black-checkered fill on the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  const selected = workbook.getSelectedRange();
  selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
  selected.getFormat().getFill().setPatternColor("black");
}

setPatternColor(patternColor)

Код цвета HTML, представляющий цвет шаблона диапазона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

setPatternColor(patternColor: string): void;

Параметры

patternColor

string

Возвращает

void

setPatternTintAndShade(patternTintAndShade)

Задает двойник, который осветляет или затемняет цвет узора для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых patternTintAndShade параметров.

setPatternTintAndShade(patternTintAndShade: number): void;

Параметры

patternTintAndShade

number

Возвращает

void

setTintAndShade(tintAndShade)

Задает двойник, который осветляет или затемняет цвет заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что диапазон не имеет одинаковых tintAndShade параметров.

setTintAndShade(tintAndShade: number): void;

Параметры

tintAndShade

number

Возвращает

void